javadoc简单使用

1,前言
java语言中,按照一定格式生成程序的文档的工具是javadoc 。个人理解,将.java文件里面的java代码转化为和源代码配套的API帮助文档。
这里就要总结一下java中一些常见的命令:
jar —— 将许多文件组合成一个jar文件
javac —— 编译
javadoc —— 它从程序源代码中抽取类,方法,成员等注释形成一个和源代码配套的API帮助文档。
javah —— 把java代码声明的JNI方法转化为C\C++头文件。

2,使用javadoc生成文档
在java文件中右键,点击Terminal,输入命令 javadoc 名字.java,回车运行。
注:这里没有考虑编码格式的问题,如果有汉字可能会乱码。
解决编码问题:javadoc -encoding UTF-8 -charset UTF-8 文件名.java
在这里插入图片描述

3,查看test文件夹下的生成的api文档
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/chegy218/article/details/83867574