代码注释插件的使用

目前遇到的问题

• 注释不规范与不统一，
• 不能表达具体代码业务所做内容
• 参数传入和传出不明确

方案

• vscode 插件 koroFileHeader

配置

• 打开vscode设置切换到用户区(User) 搜索fileheader
• 打开Config Obj将下面配置追加到配置项中

{
  ...,
  "fileheader.configObj": {
    // 当前时间为文件创建时间
    "createFileTime": true,
    // 自定义注释
    "language": {
      "languagetest": {
        "head": "/?",
        "middle": " $ @",
        "end": " $/"
      }
    },
    // 自动添加注释
    "autoAdd": true,
    // 超出100行不自动添加注释
    "autoAddLine": 100,
    // 只添加支持语言注释
    "autoAlready": true,
    // 注释行为
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": false // language
    },
    // ‘*’后缀文件第几行插入
    "headInsertLine": {},
    // '*'后缀文件注释前插入内容
    "beforeAnnotation": {},
    // '*'后缀文件注释后插入内容
    "afterAnnotation": {},
    // 修改特殊字段 Date/LastEditTime/LastEditors/Description/FilePath
    "specialOptions": {},
    // 插件开关
    "switch": {
      "newlineAddAnnotation": true
    },
    // 自动添加注释黑名单
    "prohibitAutoAdd": [
      "json",
      "md"
    ],
    // 禁止“*”项目自动添加
    "prohibitItemAutoAdd": [],
    // 移动光标到Description所在行
    "moveCursor": true,
    // 时间格式化
    "dateFormat": "YYYY-MM-DD HH:mm:ss",
    // 输入自定义信息标识符
    "atSymbol": "@",
    // 修改“*”文件自定义标识
    "atSymbolObj": {},
    // 所有注释: 改为一个空格
    "colon": ": ",
    // 修改“*”文件冒号显示格式
    "colonObj": {},
    // 路径分隔符
    "filePathColon": "/",
    // 隐藏插件报错
    "showErrorMessage": false,
    // 自动对齐
    "wideSame": true,
    // 字段等宽设置
    "wideNum": 13,
    // 重复修改撤销是否更新 暂时false true有风险
    "CheckFileChange": false,
    // 新建文件自动添加注释
    "createHeader": true
  },
  // 在光标处插入函数注释,默认配置
  "fileheader.cursorMode": {
    "Author": "101.cn",
    "LastEditors": "101.cn",
    "description": "描述信息",
    "param": "param 描述",
    "return": "{type} value 描述"
   },
  // 头部注释,默认设置
  "fileheader.customMade": {
    "Author": "101.cn",
    "Date": "Do not edit",
    "LastEditors": "101.cn",
    "LastEditTime": "Do not edit",
    "Description": "描述信息"
  },
}