程序员的基本素养之规范的Java注释

1、java类注释模板设置

要点：类(Class)注释的主要作用是声明该类的作用、类名、创建者、创建日期
示例：

配置路径：

File->Setting->Editor->File and Code Templates->Class
File->Setting->Editor->File and Code Templates->Interface
File->Setting->Editor->File and Code Templates->Enum
File->Setting->Editor->File and Code Templates->AnnotationType

内容填充：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")/**
* <p>
* ${description}
* <p>
*
*@className: ${NAME}
*@author: 靓仔也要学习
*@create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/
public class ${NAME} {}

注意： Interface、Enum、AnnotationType依次替换上面的class

2、方法注释

示例：

配置步骤：
1、进入配置路径 File->Setting->Editor->LiveTemplates
2、点击右侧 “+” -> Template Group…-> 输入组名称如“mygroup” 点击ok
3、选中创建的 “mygroup” 点击右侧 “+” -> Live Template
4.、配置模板内容和生成注释快捷键

模板内容填充：

****
$param$* @return $return$* @Description //TODO $end$* @author 靓仔也要学习* @date $date$ $time$**/

变量填充：

param变量Expression：

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) ? '\\r\\n' : '')}; return result", methodParameters())

return变量Expression：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

date、time的Expression直接选择即可。

使用注意：如图我设置的是a，生成键为Enter，则使用在方法上面输入/a按Enter即可。一定要在快捷键前面加上/

最后温馨提醒，一定要记得点击 Apply。

规范的Java注释模板设置相关推荐

Eclipse Java注释模板设置
Eclipse Java注释模板设置详解设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 ...
Eclipse Java注释模板设置详解，更改 ${user}和${date}
修改MyEclipse eclipse 注释的作者名字转自:http://www.oschina.net/question/158170_31311 在eclipse/myeclipse中,当我们去 ...
Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
[转]Eclipse Java注释模板设置详解
原文链接:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx 设置注释模板的入口: Window->Preference-&g ...
myeclipse java注释模板_Eclipse/MyEclipse Java注释模板设置详解 ---转载自百度空间
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
eclipse java 注释_Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
170828、Eclipse Java注释模板设置详解以及版权声明
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ...
java eclipse 注释模板_Eclipse Java注释模板设置详解
文件(Files)注释标签: /** * @Description: ${todo}(用一句话描述该文件做什么) * @author thomas12112406 * @date ${date} ${ ...
java注释模板_Java注释模板设置
Java注释模板设置 eclipse中设置Java注释模板 eclipse设置注释模板的入口: Window->Preference->Java->Code Style->Co ...

规范的Java注释模板设置

程序员的基本素养之规范的Java注释

1、java类注释模板设置

2、方法注释

规范的Java注释模板设置相关推荐

最新文章

热门文章