javadoc的使用

2019-10-28 00:00:00 javadoc

在进行项目开发过程中，项目接口文档是很重要的一块内容，在java项目中我们可以用swagger，asciidoc，javadoc等方式来生产文档，而其中最基本的文档生成方式就是javadoc，它一般用在离线文档的生成上，我们需要按排它的规定来书写注释，从而最终生成文档。

标准化注释

@link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
@code： {@code text} 将文本标记为code
@param：一般类中支持泛型时会通过@param来解释泛型的类型
@author：作者信息
@see ：另请参阅，其它备注
@since ：从以下版本开始
@version：当前版本号
@param：后面跟参数名，再跟参数描述
@return：返回值
@throws ：跟异常类型异常描述 , 用于描述方法内部可能抛出的异常跟返回值的描述
@exception：用于描述方法签名throws对应的异常
@see：既可以用来类上也可以用在方法上，表示可以参考的类或者方法
@value：用于标注在常量上，{@value} 用于表示常量的值
@inheritDoc：用于注解在重写方法或者子类上，用于继承父类中的Javadoc

生成doc文件

工具＝生成doc （tools=generate javaDocs…）

如果是中文注释，需要注意几点

locale：设置成zh_CN
other command line arguments 设置成-encoding UTF-8 -charset UTF-8

    原文作者：张占岭
    原文地址: https://www.cnblogs.com/lori/p/11747501.html
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。

相关文章