java注释

最新推荐文章于 2025-09-11 23:50:21 发布

weixin_30443075

最新推荐文章于 2025-09-11 23:50:21 发布

阅读量60

点赞数

CC 4.0 BY-SA版权

文章标签： java

原文链接：http://www.cnblogs.com/malianyong/p/9797466.html

本文详细介绍了一种用于项目代码注释的规范，包括文件头部注释和方法注释的具体内容，如项目名称、文件名称、描述、创建时间、作者、版本等信息，以及更新记录的格式。此外，还提供了方法注释的模板，包括标题、描述、参数、返回类型、作者、创建日期和更新记录。

首先是在文件头部添加：

/*
 * <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] [更改人姓名][变更描述]     
 */

转载于:https://www.cnblogs.com/malianyong/p/9797466.html