什么是javadoc以及注释规范

什么是javadoc

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的 API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

Javadoc命令是用来生成自己的API文档，使用方式：

javadoc 源文件名.java
javadoc -d 文档存放目录 源文件名.java
通过IDEA生成Javadoc ： Tools -> Generate JavaDoc

javadoc注释规范

// 注释一行
/ *    */ 注释若干行  
/**   ……*/  注释若干行，写入Javadoc文档

• 注释中出现以@开头东东被称之为Javadoc文档标记，是JDK定义好的，如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

写在类上的文档标注一般分为三段：

1.概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
@link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
@code： {@code text} 将文本标记为code

2.详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
@param一般类中支持泛型时会通过@param来解释泛型的类型
使用
@author来标记作者
@see 另请参阅
@since 从以下版本开始
@version 版本
3.文档标注，用于标注作者、创建时间、参阅类等信息
@return 跟返回值的描述
@param 后面跟参数名，再跟参数描述
@throws 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常
@exception用于描述方法签名throws对应的异常
@see既可以用来类上也可以用在方法上，表示可以参考的类或者方法
@value用于标注在常量上，{@value} 用于表示常量的值
@inheritDoc用于注解在重写方法或者子类上，用于继承父类中的Javadoc

参考：https://blog.csdn.net/vbirdbest/article/details/80296136