Java 文档注释的简介说明 ：
我们都知道Java语言支持单行注释和多行注释，但是Java语言还有一种自身特有的注释方式:
文档注释
主档注释的格式:
使用/** 开始，和 */结束
当我们使用文档注释对编码进行操作后，我们可使用JDK 提供的javadoc工具生成一套HTML帮助信息
javadoc工具可识别的标签如下：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |
文档注释注意事项
1.通常在 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
2.使用一个@ 标签编写其它属性值
3.多个相同类型的标签应该放成一组。例，如三个 @param 标签，可以将它们一个接一个的放在一起
例:
test.java 文件代码：
import java.io.*;
/** * 这个类演示了文档注释
* @author java265.com
* @version 1.8
*/
public class test
{
/** * 此方法是一个测试类
* 输入两个参数，将返回一个组合参数
* @param a 参数1
* @return 返回值
*/
public stringTest(string a)
{
return a+"java265.com";
}
}
版权声明
本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。
