文档注释
- @author 作者名
- @versiom 版本号
- @Since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
例如
格式;
/**
*
*/
//加在类上面就是类的注释
//加在方法上就是方法的注释
JavaDos
JavaDos命令是用来生成自己API文档的
1用cmd窗口生成
- 我们先在JDEA中把文件所在位置打开
- 在文件位置左边加上cmd空格打开cmd窗口
- 在窗口中输入javadoc -encoding UTF-8 -charset UTF-8 DOC.java命令
Javadoc;java生成文档
-encoding UTF-8 -charset UTF-8;该参数为了减少出现乱码问题
- 就会生成很多文件,我们打开其中index(首页)
- 打开后和在官方中的很像,其中有很多我们设置的参数
2用IDEA生成dos文档
再点javaDoc
上面是指范围的
中间是生成文件的位置
后面是语种和参数
在之后点OK后即生成文件