idea for mac 生成类注释和方法注释的方法

傷城~ 2022-03-18 04:10 823阅读 0赞

# 目录 #

*  生成类注释
 *  生成方法注释

#### 生成类注释 ####

####  ####

类注释模板：

/**
    * @program: ${PROJECT_NAME}
    * @description: ${description}
    * @author: 作者名称
    * @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
    **/

步骤：

1.  打开Preferences（快捷键 `command + ,`）
2.  Editor -> File and Code Templates -> Includes -> File Header  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70]
3.  效果图  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 1]

#### 生成方法注释 ####

####  ####

方法注释模板：  
模板中第一行我没有给定斜杠 `/`，因为会出现一个小bug。因为我们使用时先在方法上输入`/`\+你的 Abbreviation

** 
     * @description: $description$ 
     $params$
     * @return: $returns$ 
     * @author: King
     * @date: $date$ 
     */

1.  打开Preferences
2.  Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 2]  
    设置Expression：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 3]

params：

> groovyScript(“def result=’’; def params=”$\{\_1\}".replaceAll(’\[\\\\\[|\\\\\]|\\\\s\]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) \{result+=’\* @param ’ + params\[i\] + ((i < params.size() - 1) ? '\\n ’ : ‘’)\}; return result", methodParameters())

return：

> 选择 methodReturnType()

date：

> date(“yyyy-MM-dd HH:mm”)

1.  使用，给方法添加注释  
    `/`\+`method（我自己设置的Abbreviation）`\+`tab或者回车`![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 4]  
    效果：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 5]

参考：  
[在idea中为类和方法自动生成注释][idea]  
[idea生成类注释和方法注释的正确方法][idea 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70]: /images/20220318/d8b2a61425174ad585efb6b5f6409719.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 1]: /images/20220318/63c19413f9e14ca3b2fb45d928ec90ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 2]: /images/20220318/1f92f8be618c4eb9b62543bb097e46e5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 3]: /images/20220318/c9dbfcff97c6495f8f43a3fd94a33270.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 4]: /images/20220318/100de2730df847099650dd0f81fa30b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTQ2Mzk3MQ_size_16_color_FFFFFF_t_70 5]: /images/20220318/a74a657d7f57466c9c2836edf8f2567b.png
[idea]: https://my.oschina.net/mojiayi/blog/1608746
[idea 1]: https://blog.csdn.net/qq_34581118/article/details/78409782