Idea和eclipse设置类注释和方法注释的方法
原创
©著作权归作者所有:来自51CTO博客作者Emiyas的原创作品,请联系作者获取转载授权,否则将追究法律责任
首先来说说eclipse的方法吧,话不多说,直接上教程
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template
然后展开Comments节点就是所有需设置注释的元素。
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: (描述该文件做什么)
* @author ${user}
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: (描述这个类的作用)
* @author ${user}
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(描述这个变量表示什么)
*/
构造函数(Constructor)标签:
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
方法(Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: (描述这个方法的作用)
* ${tags}
* @return ${return_type}
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代理方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} the ${bare_field_name} to set
*/
然后重点是idea的类的注释和方法的注释
图中是我已经设置好了的,右边的代码为:
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: hw
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
public class ${NAME} {
}
@author为你自己的名字或者标志之类的,然后我们来看看效果
这样就可以直接出来和类相关的信息了,接下来是方法的注释
点击+号选择第二个
随便输入一个名字,然后选中刚刚创建的点击+号选择第一个
输入相关信息,点击下面的Define,选中咱们的java
设置好了之后就行了,测试效果
然后贴上注释代码
** @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: hw
* @Date: $date$
*/