java文档注释

java文档注释

目录

• java文档注释
  • javadoc标签
  • 文件头部注释
  • 方法的注释
  • getter和setter

javadoc标签

• @author 标识一个类的作者
• @deprecated 指明一个过期的类或成员
• {@docRoot} 指明当前文档根目录的路径
• @exception 标志一个类抛出的异常
• {@inhertDoc} 从直接父类继承的注释
• {@link} 插入到另一个主题的链接
• {@linkplain} 插入一个到另一个主题的连接,但是该连接显示纯文本字体
• @param 说明一个方法的参数
• @return 说明返回值的类型
• @see 指定一个到另一个主题的连接 @see BeanNameAware#setBeanName 中间的#后的文字代表该类下的方法或属性
• @serial 说明一个序列化属性
• @serialData 说明通过writeObject()和writeExternal()方法写的数据
• @serialFiled 说明一个ObjectStreamField组件 Java.io.ObjectStreamField类是可序列化字段来自Serializable类的描述。 ObjectStreamFields数组用来声明一个类的序列化字段。
• @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] [更改人姓名][变更描述]
 */
 
 以上内容来源自菜鸟教程的JeoSaber用户

方法的注释

/**
 * @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] [更改人姓名][变更描述]     
 */
 
  以上内容来源自菜鸟教程的JeoSaber用户

getter和setter

/**
 * 获取  ${bare_field_name}
 */



/**
 * 设置   ${bare_field_name} 
 * (${param})${field}
 */
 
  以上内容来源自菜鸟教程的JeoSaber用户