编程中为了提高代码可读性,会添加一些注释,对方法、类的注释需要的信息多一些,纯手工制作伤神又费力,下面给大家提供两种方法:
1>如果已有注释模板:
加注释说明方法<1>: /** + 回车键
<2>: shift + alt + j (极力推荐) 如果中文输入法下不好使,切换成英文或关掉输入法。
2>还没有模板的话
MyEclipse、Eclipse注释模板:Window->Preference->Java->Code Style->Code Template
(1) Comments-Types 类注释
/* *
* @author 你的名字
* @ClassName: ${type_name}
* @Version 版本
* @ModifiedBy 修改人
* @Copyright 公司名称
* @date ${date} ${time}
* @description 类描述
*/
(2) Comments-Methods 方法注释
/* *
* @author 你的名字
* @title: ${enclosing_method}
* @date ${date} ${time}
* ${tags} ${return_type}
*/
(3)
Comments-Constructors 构造方法注释
/**
* @author 你的名字
* @date ${date} ${time}
* ${tags}
*/
中文版:
/**
* @描述:
* @作者: 你的名字
* @版本:1.0
* @版权所有:公司名
* @时间 ${date} ${time}
*/
/**
* @描述:
* @作者:你的名字
* @时间:${date} ${time}
* @参数:${tags}
* @返回值:${return_type}
*/
内容仅供参考学习,不周全之处多提意见!