idea设置类头注释和方法注释

最新推荐文章于 2024-08-18 21:51:48 发布

jsxllht

最新推荐文章于 2024-08-18 21:51:48 发布

阅读量794

点赞数

文章标签： intellij-idea java intellij idea

本文链接：https://blog.csdn.net/weixin_56219549/article/details/121714944

版权

IDEA Eclipse 注释模板配置代码规范

关键词由CSDN通过智能技术生成

一类头注释

 #if (${PACKAGE_NAME} && ${ACKAGE_NAME} != "") package ${PACKAGE_NAME};#end
 #parse("File Header.java")
   /**  
    * @ClassName: ${NAME}
    * @Description: ${todo}
    * @Author author
    * @Date ${DATE} ${TIME}
    * @Version 1.0
    */
 public class ${NAME} {
 }

在这里插入图片描述

二方法注释

自定义方法注释

/**
* @Description: ${todo}
* @param ${tags}
* @return ${return_type}
* @throws
* @author ceshi
* @date $date$ $time$
*/

在这里插入图片描述
因为IDEA生成注释的默认方式是：模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为add+Tab

IDEA自带方法注释

其实IDEA可以通过选中方法名，然后ALT+ENTER键然后选择"add javadoc"来给方法自动生成注释

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
*/