Doc参数信息

java Doc

java Doc在编程中，需要用到文档注释（文档注释：/ * * 回车）。java Doc是可以将注释信息生成为一个帮助文档的技术，也就是生成一个api技术文档。帮助文档也可自己手动在网页中打开

点击跳转API帮助文档

 

Doc参数信息

@author 作者名

@version 版本号

@since （自然号）指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况(出现异常会提醒)

如何将java生成文档

选择需要生成的类，右键Show in Explorer(打开文件夹)。在文档路径前输入CMD空格打开命令行。

在命令行内输入javadoc （生成文档）-encoding(编码) UTF-8(编码格式) -charset UTF-8 Doc.java(这是选择的类的名字，后面加上.java)

输入生成文档的命令，为防止中文产生的乱码，输入编码命令，让他的编码格式为UTF-8，输入字符串的命令，让他的编码格式也为UTF-8，最后加上需生成文档的类的名字，加上java。