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

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

 

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

如上图所示,建立类,方法和继承方法后 的效果。git

配色图以下所示github

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

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

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)注释标签:spa

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

 

Constructor 标签:3d

/** 
* 
* ${tags} 
*/

 

方法(Methods)标签:code

/** 
 * @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

相关文章
相关标签/搜索