类注释规范

一个处女座的暖男程序猿2024-06-20 9:17

类注释规范

1.1.1 模板配置

模板路径：File-->settings-->Editor-->File and Code Templates-->Includes-->File Header

 N A M E ：设置类名，与下面的 {NAME}：设置类名，与下面的 NAME：设置类名，与下面的{NAME}一样才能获取到创建的类名

TODO：代办事项的标记，一般生成类或方法都需要添加描述

@Author 不要用自动获取，固定写上自己名字

 D A T E 、 {DATE}、 DATE、{TIME}：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}

cpp 复制代码

/**
 * 此处写该类描述
 * 
 * @author 罗继全
 *${DATE} ${TIME}
 */