javadoc的使用

• javadoc命令是用来生成API文档的，使用  /** + 回车来生成注释

• 参数信息

1. @author 作者名

2. @version 版本号

3. @since 指明需要最早使用的jdk版本

4. @param 参数名

5. @return 返回值情况

6. @throws 异常抛出情况　　　　　　

• 生成doc文档的两种方式

1. 利用cmd命令来生成doc文档

　　　　找到当前类的路径：右击当前类，点击Show in Explorer

 

 

              

　　　　 在当前路径下打开cmd，输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java，将会自动在此文件夹下生成文档

                  

 

　 　2.利用idea生成doc文档

　　　　选择Tools下的Generate JavaDoc

　　　　    　　

 

　　　　选择文档保存路径以及编码格式