IDEA Java代码注释规范

一、首先我们来设置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());

public String test(){return null;
}

public void test{return null;
}

IDEA Java代码注释规范相关推荐

java 注释超链接_java_Java代码注释规范详解，代码附有注释对程序开发者来 - phpStudy...
Java代码注释规范详解代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一在整个应 ...
eclipse java代码某一行需要修改注释_看看这些Java代码开发规范吧！你好，我好，大家好！...
作为一名开发人员,当你接手他人的项目时,且当你阅读他人的代码时,是有没有遇到脑袋充血,感觉Java要把你"送走"的感觉呢?我们在用Java开发技术进行开发前,一定要牢牢恪守Java ...
长沙北大青鸟java 学费_长沙北大青鸟学校好不好长沙北大青鸟实力学费一览表:Java代码编写规范（二）...
原标题:长沙北大青鸟学校好不好长沙北大青鸟实力学费一览表:Java代码编写规范(二) 文件名规范 1.一个Java源文件只能存储个Java类. 2.文件名与Java类名相同. 3.一个类文件的代码行 ...
PHP中类和文件的代码注释规范
编写好的文档对于任何软件项目都至关重要,不仅是因为文档的质量可能比代码的质量更重要,还因为良好的第一印象会促使开发人员进一步查看代码以及后续的迭代. 文件注释 /*** Sample file com ...
python代码大全中文注释_零基础小白必看篇：Python代码注释规范代码实例解析操作（收藏）...
本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!! 一.代码注释介绍注释就是对代码的解释和说明 ...
python代码_零基础小白必看篇：Python代码注释规范代码实例解析操作（收藏）
本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!! 一.代码注释介绍注释就是对代码的解释和说明 ...
java dao层编写及注释_JAVA代码注释规范
2. 班级: 班级的目的,即班级完成的功能,以及班级的创建时间和作者姓名:当多个人一次编辑或修改同一个班级时, 作者姓名中应出现多个姓名: 3. 接口: 在满足类注释的基础上,接口注释应包含设置接口的 ...
java的注释规范_Java代码注释规范
1,单行(单行)-简短说明: ///... 单行注释: 代码中的单行注释. 最好在注释前有一个空行,并在其后加上与代码相同的缩进级别. 如果无法完成一行,则应使用块注释. 评论格式: 在行首注释: 在 ...
开发规范-java代码注释及IDEA配置代码注释模板
引(阿里巴巴开发规范-注释规约) [强制]类.类属性.类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用 // xxx 方式. 说明:在 IDE 编辑窗口中,Javadoc 方式 ...

IDEA Java代码注释规范

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

1、设置类注释模板

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

二、设置方法注释模板

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

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

3.点击Define，勾选Java

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

其他注解

类注解：

logger日志

pst

pvt

IDEA Java代码注释规范相关推荐

最新文章

热门文章

IDEA Java代码注释规范

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

1、设置类注释模板

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

二、设置方法注释模板

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

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

3.点击Define，勾选Java

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

其他注解

类注解：

logger日志

pst

pvt

IDEA Java代码注释规范相关推荐

最新文章

热门文章

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