java基础学习-使用Doc命令行创建说明文档

步骤:打开cmd输入javaDoc -d filename -author -version className.java

如需要生成一个名为JavaTool的工具类的说明书,并保留在一个名为help的文件夹中,则在终端中输入命令为:javaDoc -d help -author -version JavaTool.java

在java中需要使用文档注释方式来进行注释,

@author:作者

@version:版本号

用于在class类声明的时候

如:

/**

@author 张三

@version V1.0

*/

class JavaTool{

@param:参数

@return:运行结果

用于注释对象当中的方法。

你可能感兴趣的:(java基础学习-使用Doc命令行创建说明文档)