idea文件注释配置

🤷‍♂️ 方法一:配置总的文件注释:

idea 全局搜索file code
在这里插入图片描述
代码如下,最上面有一个换行


/**
*   ${description}.
*
*   @author : Q
*   @version : 1.0 ${YEAR}/${MONTH}/${DAY}
*   @since : 1.0
**/

✨方法二:单独文件配置

同样的位置,如果想单独配置文件,可以选择具体的文件类型配置,具体的内容可以自行配置修改,原本里面的#parse("File Header.java")就是上面配置的总的,如果不需要总配置,需要把这行删除,不然可能会出现两个注释的问题。
在这里插入图片描述
具体的class、interface、enum配置都差不多,本质上就是修改模板,具体什么效果还是看你自己的配置。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

/**
*   ${description}.
*
*   @author : qs
*   @since : 1.0 ${YEAR}/${MONTH}/${DAY}
**/
public class ${NAME} {
}

🎂 具体推荐

1、一般配置通用的模板头就可以了
2、尽量配置作者名称用缩写 比如单个单词Q 或者 缩写qs(qiushi的缩写),因为好看
3、配置完成之后看效果再调试,最好包括格式化代码,因为注释可能会因为格式化代码而换顺序

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
配置Idea的文档注释,可以按照以下步骤进行操作: 1. 点击菜单栏中的"File",选择"Settings"。 2. 在弹出的窗口中,选择"Editor",然后点击"Code Style"。 3. 在"Code Style"下拉菜单中,选择"Java"。 4. 在右侧的选项卡中,选择"JavaDoc"。 5. 在"JavaDoc"选项卡下,你可以看到一个"Default settings"部分。 6. 点击右侧的"Edit"按钮,然后点击"Edit variables"。 7. 在弹出的窗口中,你可以配置你的文档注释模板。你可以使用变量和标签来自定义注释内容。 8. 配置完成后,点击"OK"保存设置。 这样,你就可以在Idea中使用自定义的文档注释模板了。当你在方法或类上使用快捷键生成注释时,Idea会根据你的配置自动生成相应的注释模板。请参考 。 <span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [IDEA文档注释(教程+模板)](https://blog.csdn.net/XX_sir/article/details/114601146)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [IDEA 注释模板](https://blog.csdn.net/Lxl1418/article/details/126603185)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值