VSCode的koroFileHeader使用

ゝ一世哀愁。 2024-04-19 14:46 4阅读 0赞

### 1.在vscode中查找插件koroFileHeader ###

使用 \[koroFileHeader\](https://marketplace.visualstudio.com/items?itemName=OBKoro1.korofileheader) 插件用于快速生成开发者注释。koroFileHeader是一款用于在vscode中用于生成文件头部注释和函数注释的插件，支持所有主流语言,功能强大，灵活方便，文档齐全。

![20190919101652546.png][]

###  2.功能 ###

文件顶部的注释，包括描述、作者、日期、最后编辑时间，最后编辑人
    
      ```typescript
      /*
       * @Description: app im菜单配置列表中的表格模块
       * @Author: maoyuyu
       * @Date: 2019-08-05 10:31:12
       * @LastEditTime: 2019-08-14 17:08:33
       * @LastEditors: Please set LastEditors
       */
      ```
    
      > **文件头部添加注释快捷键**：`window`：`ctrl+alt+i`,`mac`：`ctrl+cmd+i`
      >
      > **在光标处添加函数注释**：`window`：`ctrl+alt+t`,`mac`：`ctrl+cmd+t`
      >
      > **vscode setting 配置如下**
    
      ```json
      "fileheader.configObj": {
        "autoAdd": false, // 自动添加头部注释开启才能自动添加
      },
      "fileheader.customMade": {
        "Author":"[you name]",
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "[you name]", // 文件最后编辑者
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "Description":""
      },
      "fileheader.cursorMode": {
        "Author":"[you name]",
        "description": "", 
        "param": "", 
        "return":""
      }
      ```

### 3.编译器的设置 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70 2][]

[20190919101652546.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/9cf7ba23f60047b581efdba7f550fb5e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/ebeb221f878e4519a734179397233232.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/9175f9391341447d9593804624cafdd6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb3lhbjA4Mjk_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/0959b571fcd14cd3921c4500238c6b1f.png