Java之开发工具(1) - Eclipse 如何设置注释的模板
最常用的注释就是对类的说明和方法的说明,关于这类代码的注释方式,在Eclipse中可以这样进行设置:
windows---preferences...---java--code style--code Templates---Comments就可以进行设置了。
这里的设置包括常量和变量,变量的类型可以随时自动插入,就用insert varaibles....这个功能,会列出系统中提供的变量。
文件注释标签:
Java代码
- /**
- * @Title: ${file_name}
- * @Package ${package_name}
- * @Description: ${todo}(用一句话描述该文件做什么)
- * @author A18ccms A18ccms_gmail_com
- * @date ${date} ${time}
- * @version V1.0
- */
类型注释标签(类的注释):
Java代码
- /**
- * @ClassName: ${type_name}
- * @Description: ${todo}(这里用一句话描述这个类的作用)
- * @author A18ccms a18ccms_gmail_com
- * @date ${date} ${time}
- *
- * ${tags}
- */
字段注释标签:
Java代码
- /**
- * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
- */
构造函数标签:
Java代码
- /**
- *
- Title:
- *
- Description:
- * ${tags}
- */
方法标签:
Java代码
- /**
- * @Title: ${enclosing_method}
- * @Description: ${todo}(这里用一句话描述这个方法的作用)
- * @param ${tags} 设定文件
- * @return ${return_type} 返回类型
- * @throws
- */
覆盖方法标签:
Java代码
- /* (非 Javadoc)
- *
- Title: ${enclosing_method}
- *
- Description:
- * ${tags}
- * ${see_to_overridden}
- */
代表方法标签:
Java代码
- /**
- * ${tags}
- * ${see_to_target}
- */
getter方法标签:
Java代码
- /**
- * @return ${bare_field_name}
- */
setter方法标签:
Java代码
- /**
- * @param ${param} 要设置的 ${bare_field_name}
- */
新建Java文件:
Java代码
- ${filecomment}
- ${package_declaration}
- /**
- * @Title: ${file_name}
- * @Package ${package_name}
- * @Description: ${todo}(添加描述)
- * @author A18ccms A18ccms_gmail_com
- * @date ${date} ${time}
- * @version V1.0
- */
- ${typecomment}
- ${type_declaration}