IDE-Ecplise-代码注释 模版 编码规范 配色

说明： 代码注释主要用于方便代码后期维护，编码规范，增加代码阅读性和维护性。因网上看到的很多博客中片段局多，故整理后重写一篇，方便交流学习。

　

• 　　先看下加过注释模版后的效果。

如上图所示，创建类，方法和继承方法后 的效果。

配色图如下所示

• 先看下ecplise中模版设置的位置

依次打开 Preferences －》Java选项 －》Code Style －》Code Templates－》Comments

look 如上图所示 ： comments 节点下对应的节点就是创建文件，类，方法的注释模版的位置了

• 关于每个节点下的注释写法

文件(Files)注释标签：

/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}(用一句话描述该文件做什么)
 * @author <作者姓名>
 * @date ${date}${time}

类型(Types)注释标签（类的注释）：

/**
 * @ClassName: ${type_name}
 * @Description: ${todo}(这里用一句话描述这个类的作用)
 * @author <作者姓名>
 * @date ${date} ${time}
 * ${tags}
 */ 

字段(Fields)注释标签：

/**
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
 */

Constructor 标签：

/**
*
* ${tags}
*/

方法(Methods)标签：

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个方法的作用)
 * @param ${tags}    设定文件
 * @return ${return_type}    返回类型
 * @throws
 */

覆盖方法(Overriding Methods)标签：

/*
*<非doc 标签>
* Title: ${enclosing_method}
* Description: ${todo} 父类方法描述
* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)标签：

/**
 * ${tags}
 * ${see_to_target}
 */

Getter方法标签：

/**
 * @return the ${bare_field_name}
 */

Setter方法标签：

/**
 * @param ${param} the ${bare_field_name} to set
 */

• 最后一点小细节 如果你想要创建类的时候就自动有注释 请看下图

　　　

• 关于doc文档常用注释元素的含义 <引用>，想了解更多可搜索  　"javadoc标记" 即可

• 标签中函数写法见提示即可

　

• 最后简单说下配色方案

　　可以到如下网址去下载配置文件然后倒入到ecplise中

　　http://eclipsecolorthemes.org/?list=toppicks&lang=java

或者在ecplise中 Help->install new soft->add   添加如下网址 http://eclipse-color-theme.github.com/update 进行更新

更新后 在Preferences->General->color theme中就可以找到相应的模版方案了

• 结篇  附上模版文档，如有遗漏欢迎指证

链接: http://pan.baidu.com/s/1jG8Lj8q 密码: zh7f