Eclipse 如何设置注释的模板

最新推荐文章于 2025-03-06 15:28:07 发布

laukaka

最新推荐文章于 2025-03-06 15:28:07 发布

阅读量818

点赞数

文章标签： eclipse date tags javadoc insert file

本文介绍如何在Eclipse中设置代码注释模板，包括文件、类、字段及方法等不同类型的注释标签，帮助开发者提高代码可读性和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

http://redish.iteye.com/blog/587922

最常用的注释就是对类的说明和方法的说明，关于这类代码的注释方式，在Eclipse中可以这样进行设置：
windows---preferences...---java--code style--code Templates---Comments就可以进行设置了。
这里的设置包括常量和变量，变量的类型可以随时自动插入，就用insert varaibles....这个功能，会列出系统中提供的变量。

文件注释标签：

/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * @author 
 * @date ${date} ${time}
 * @version V1.0
 */

类型注释标签（类的注释）：

/**
 * @ClassName: ${type_name}
 * @Description: ${todo}
 * @author 
 * @date ${date} ${time}
 * ${tags}
 */

字段注释标签：

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

构造函数标签：

/**
 *
Title: 
 *
Description: 
 * ${tags}
 */

方法标签：

/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}
 * ${tags}
 * @return ${return_type} 
 * @throws
 */

覆盖方法标签：

/* (非 Javadoc)
*
Title: ${enclosing_method}
*
Description: 
* ${tags}
* ${see_to_overridden}
*/

代表方法标签：

/**
* ${tags}
* ${see_to_target}
*/

getter方法标签：

/**
* @return ${bare_field_name}
*/

setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

新建Java文件：

${filecomment}
${package_declaration}
/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * @author 
 * @date ${date} ${time}
 * @version V1.0
 */
${typecomment}
${type_declaration}