javadoc的使用

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

标准化注释

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

生成doc文件

工具=生成doc (tools=generate javaDocs...)

  • 如果是中文注释,需要注意几点
  1. locale:设置成zh_CN
  2. other command line arguments 设置成-encoding UTF-8 -charset UTF-8
posted @ 2019-10-27 14:36  张占岭  阅读(...)  评论(... 编辑 收藏