//单行注释
/**/多行注释
单行注释和多行注释,注释了的内容不参与编译。
编译以后生成的.class结尾的字节码文件中不包含注释掉的信息
多行注释不可以嵌套使用
还可以用来调试代码,把不确定哪个地方有没有写错的时候,注释掉看还报不报错
只能提取文档注释
javadoc -d 文件夹名称 -author -version 源文件名称.java
/** */文档注释(Java特有的),可以使用javadoc工具软件来生成信息,并输出到HTML文件中
@author | 标识一个类的作者 |
@deprecated | 指名一个过期的类或成员 |
{@docRoot} | 指明当前文档根目录的路径 |
@exception | 标志一个类抛出的异常 |
{@inheritDoc} | 从直接父类继承的注释 |
{@link} | 插入一个到另一个主题的链接 |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 |
@param | 说明一个方法的参数 |
@return | 说明返回值类型 |
@see | 指定一个到另一个主题的链接 |
@serial | 说明一个序列化属性 |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 |
@serialField | 说明一个ObjectStreamField组件 |
@since | 标记当引入一个特定的变化时 |
@throws | 和 @exception标签一样. |
{@value} | 显示常量的值,该常量必须是static属性。 |
@version | 指定类的版本 |
来源于菜鸟教程
在文件头部添加:
/* * <p>项目名称: ${project_name} </p> * <p>文件名称: ${file_name} </p> * <p>描述: [类型描述] </p> * <p>创建时间: ${date} </p> * <p>公司信息: ************公司 *********部</p> * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a> * @version v1.0 * @update [序号][日期YYYY-MM-DD] [更改人姓名][变更描述] */
方法:
/** * @Title:${enclosing_method} * @Description: [功能描述] * @Param: ${tags} * @Return: ${return_type} * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a> * @CreateDate: ${date} ${time}</p> * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述] */
getter
/** * 获取 ${bare_field_name} */
setter
/** * 设置 ${bare_field_name} * (${param})${field} */