IDEA Java代码注释规范

it2024-03-31  52

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、设置类注释模板

File > settings > Editor > File and Code Templates > Files

我们需要设置的类模板有四个,Class、Interface、Enum、Annotation。 (1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名  (2)TODO:代办事项的标记,一般生成类或方法都需要添加描述  (3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}  (4)1.0:版本号

Class(Class、Interface、Enum、Annotation的配置都是一样的):

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") /** *@ClassName ${NAME} *@Description TODO *@Author oyc *@Date ${DATE} ${TIME} *@Version */ public class ${NAME} { }

二、设置方法注释模板

Idea没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下。 

1. 选择File–>Settings–>Editor–>Live Templates,先选择右侧加号新建一个自己的模板组,如图 我这里命名模板组名为oycJavaGroup;

2.新建模板,选中新建的模板组,点击右侧的"    +    ",选择"Live Template"

/** * @Description: $enclosing_method$ $params$ * @return * @throws */

3.点击Define,勾选Java 

4.点击Edit variables编辑变量,设置如下,点击Ok–>Apply完成设置。

params

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())

其他注解  

类注解:

/** * @ClassName: $ClassName$ * @Description: $ClassName$ * @Author oyc * @Date $date$ $time$ * @Version 1.0 */

时间格式化:date("yyyy年MM月dd日")

logger日志

private Logger logger = LoggerFactory.getLogger(this.getClass());

pst

public String test(){ return null; }

pvt

public void test{ return null; }

 

最新回复(0)