java基础语法知识08-JavaDoc

JavaDoc

学好java必买《java核心技术卷I》
javadoc命令是用来生成自己API文档的

参数信息：

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @ throws 异常抛出情况

使用javadoc生成文档可以有两种命令

命令1： javadoc -d 文档存放目录 -author -version 源文件名.java

这条命令编译一个名为"源文件名.java"的 java 源文件，并将生成的文档存放在"文档存放目录"指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略

命令2：javadoc -encoding UTF-8 -charset UTF-8 源文件名.java

找到你当前项目所写类的地址然后用命令提示符打开输入命令2就在你的文件夹中可以生成一个.html的文件了。

特别注意：命令2中 -encoding UTF-8 -charset UTF-8 这段代码是用来防止不识别中文或者出现乱码时写的。

添加链接描述