javadoc注释

最新推荐文章于 2024-08-12 20:46:24 发布

魑魅魍魉◑﹏◐

最新推荐文章于 2024-08-12 20:46:24 发布

阅读量2.1k

点赞数

分类专栏： java 文章标签： java javadoc javadoc注释 java注释

本文链接：https://blog.csdn.net/cccxu_/article/details/81326068

版权

java 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

总览

javadoc程序从下面几个特性中抽取信息：
1. 包
2. 公有类与接口
3. 公有的和受保护的构造器及方法
4. 公有的和受保护的域

应当为以上几个部分编写注释，注释放在代码前面，格式略。

文档注释中可以包含HTML修饰符，需要使用{@code … }来键入代码以避免转义代码中的<。

类注释

类注释放在import语句之后，类定义之前。

方法注释

放在方法之前。

除了通用标记，还有以下标记：
1. @param变量描述：对当前方法的”param”部分添加条目，可以占据多行并可使用HTML标记，一个方法的所有@param标记必须放在一起。
2. @return描述：描述返回参数。
3. @throws类描述：将添加一个注释，表示这个方法可能抛出异常。

域注释

只需要对公有域（通常指静态常量）建立文档。

通用注释

类文档中：
1. @author姓名
2. @version版本
3. @since对于引入特性的版本描述，比如@since version 1.7.1。
4. @deprecated表明不再使用。
5. @see将在 see also 部分增加一个链接。可以有多个@see但是必须放在一起。如果不指明label则显示目标代码名或url。
- 可用格式：package.class#feature label。javadoc会自动寻找这个类并添加链接。
- 可用格式：label, 可以用来插入URL。
- 可用格式：”text”
6. 另一个插入链接的方法: {@link package.class#feature label}