我要评论java头文件注释模板
基础模板
/**
* 类描述信息
*
* @author 作者名
* @date ${date}
* @version 1.0
*/
public class classname {
// 类内容
}
企业级详细模板
/**
* @classname: classname
* @description: 类功能详细描述
* 可以多行描述
* @author: 作者名
* @date: ${year}-${month}-${day}
* @version: 1.0.0
* @since: 1.8
* @deprecated: false
*/
public class classname {
// 类内容
}
带版权信息模板
/**
* copyright © ${year} 公司名称. all rights reserved.
*
* @projectname: 项目名称
* @package: com.xxx.xxx
* @classname: classname
* @description: 类描述
* @author: 作者名
* @date: ${year}-${month}-${day} ${time}
* @version: v1.0
*/
public class classname {
// 类内容
}
方法注释模板
/**
* 方法功能描述
*
* @param param1 参数1描述
* @param param2 参数2描述
* @return 返回值描述
* @throws exceptiontype 异常描述
*/
public returntype methodname(paramtype param1, paramtype param2) {
// 方法体
}
ide配置指南
idea live templates配置
- 打开设置：
file → settings → editor → live templates - 新建模板组：
java template - 添加模板：
abbreviation: header description: 文件头注释 template text: /** * @description: $description$ * @author: $user$ * @date: $date$ $time$ * @version: 1.0 */
- 设置生效范围：
java → declaration
常用ide变量
${date}- 当前日期${time}- 当前时间${user}- 用户名${project_name}- 项目名
团队规范示例
/**
* 订单服务类
* <p>负责订单的创建、查询、修改等操作</p>
*
* @author zhangsan
* @date 2024-01-15
* @version 1.0.1
* @since jdk 1.8
* @see orderdao
* @see ordervo
*/
public class orderservice {
// 类内容
}
最佳实践
- 注释内容保持简洁明了
- 代码修改时同步更新注释
- 团队内部统一注释格式
- 描述信息需具体有意义
- 规范使用javadoc标签
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持代码网。
发表评论