JAVA注释 javadoc 标记含义

原创于 2017-12-09 14:34:08 发布 · 825 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#javadoc #注释 #class

架构之师专栏收录该内容

17 篇文章

订阅专栏

本文详细介绍了Javadoc注释的基本用法及常见标记，包括@Author、@Version、@See、@Param、@Return和@Exception等，为开发者提供一份实用的Javadoc使用指南。

javadoc 标记由@ 符号开始其后跟的标记类型和专用注释引用组成

常用标记如下：

/**
 * @author 标明开发该类模块的作者
 * @version 标明该类模块的版本
 * @see 参考转向，也就是相关主题
 * @param 对方法中某参数的说明
 * @return 对方法返回值的说明
 * @exception 对方法可能抛出的异常进行说明
 * @return 返回值说明
 * @throws Exception 抛出的异常
 */