#代码美化# VsCode 一键添加作者信息、函数注释

需求

想写出一眼看过去就很屌的代码，添加规范化注释必不可少。

规范美观的注释不仅让代码看上去很屌，最重要的是提高代码可读性，不论自己后续维护还是让别人看，都会提高效率。

比如C++那些库函数的注释，每个封装的库文件的开头，都有很长一段绿色的注释，包含了文件的版权、功能描述等。我们自己写代码也要养成为代码添加注释的习惯。

内容

一般在写每一个脚本文件时，都要在文件开头写上本文件的描述和作者信息；

写一个函数，需要写函数的功能、输入输出、传递参数。

本文记录了在VsCode中一键添加注释的方法。

具体方法

1. 添加用户代码片段（点击左下角齿轮）

 2. 选择文件类型，以我常用的C++开发为例，文件类型为cpp文件，这里选择cpp.josn

3. 在cpp.josn中，以作者信息和函数注释代码片段为例，在文件中添加下列信息：

	"Print to Description": {
        "prefix": "description",
        "body": [
            "/*",
            "* @Description: $0",
            "* @Author: Chenxu Wen",
            "* @Date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
            "* @LastEditTime: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
            "*/"
        ],
        "description": "a description mode"
    },
    "Print to func": {
        "prefix": "func",
        "body": [
            "/**",
            " * @func $1",
            " * @desc $2",
            " * @param {$3} $4 $5",
            " * @return {$6} $7",
            " */"
        ],
        "description": "a func mode"
    }

"prefix"后跟的，即为关键字，"body"后跟的，即为添加注释的主体。

4. 在要添加注释的地方，输入关键字，即可一键添加对应注释。