Logo

郎哥编程

注释很重要

2019-07-16 214

代码的注释对编写的代码起到一个解释的作用,借助于代码注释可以让其他开发者很容易看懂你写的代码,理解代码结构,也有助于你在很长时间后,能够看懂自己写的代码。

我们可以借助eclipse提供的注释生成机制来自动创建注释,当然有些注释内容还是需要我们手动输入的。

eclipse创建类文件时,默认状态是不生成注释的,需要对eclipse进行配置,让其在创建类文件、添加属性和方法时,自动生成相关注释。eclipse的代码注释分为Files、Types、Fields、Constructors、Methods、Overriding methods、Delegate methods、Getters、Setters类型。

Files:类文件的注释。

Types:类的注释。

Fields:类属性的注释。

Constructors:类构造函数的注释。

Methods:类方法的注释。

Overriding methods:重写方法的注释。

Delegate methods:委托方法注释。

Getters: 类属性Get方法注释。

Setters:类属性Set方法注释。

打开eclipse配置选:

Window->Preference->Java->Code Style->Code Template

 image.png                                            

配置步骤为:

(1)选择注释配置项,如选择Files配置项,Files的注释模板内容会显示在下方Pattren框中,如下图所示:

image.png


(2)如果注释模板格式不符合项目对注释的要求,可以单击【Edit…】编辑注释模板,在注释模板编辑对话框中编辑注释模板内容,也可以单击【Insert Variable…】插入注释变量,注释模板编辑完成后,单击【ok】按钮即可。如下图所示:

image.png


配置Comments下的每个选项的模版,我们依次配置:

(1)Files

/** 
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author ${user} 
* @date ${date} 
* @version V1.0 
*/

(2)Types

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

(3)Fields

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

(4)Constructors

/** 
* 创建一个新的实例 ${enclosing_type}. 
* 
* ${tags} 
*/

(5)Methods

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

(6)Overriding methods

/**
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/

所有注释模板配置完成后,需要勾选下图的Automatically ………检查框,并单击【Apply and Close】按钮即可完成注释模板的配置。



代码在线纠错(通义千问 qwen-max)

支持粘贴多个代码文件,提交后由阿里云通义千问自动分析代码漏洞、语法错误、逻辑问题并给出修改建议。
您已解锁 AI 代码纠错功能,可正常使用!

评论区

登录 后发表评论
暂无评论