IDEA设置文件头注释

迷南。 2023-10-01 16:21 70阅读 0赞
前言
  1. 类、类属性、类方法的注释必须使用javadoc规范，使用/**内容*/格式，不得使用//xxx方式和/*xxx*/方式。 
  2. 说明：在IDE编辑窗口中，javadoc方式会提示相关注释，生成javadoc可以正确输出相应注释；
  3. 在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
文件头注释

打开file->setting->Editor->File and Code Templates->Includes->File Header

  1. /**
  2.  * @author: xxx
  3.  * @createTime: ${YEAR}/${MONTH}/${DAY} ${TIME}
  4.  * @company: https://www.xxx.cn
  5.  * @description: ${description}
  6.  */
  9. 或者：
  11.  /**
  12.     * @beLongProjecet: ${PROJECT_NAME} 
  13.     * @beLongPackage: ${PACKAGE_NAME}
  14.     * @author: xxx
  15.     * @createTime: ${YEAR}/${MONTH}/${DAY} ${TIME}
  16.     * @description: ${description}
  17.     * @version: v1.0
  18.  */
效果：

image-20220124155126168

  1. 配合javaDoc这个插件完善你的代码说明。

发表评论

表情：
评论列表 （有 0 条评论，70人围观）

还没有评论，来说两句吧...

相关阅读