apimap-quick-comment README这是为快速写 pb 文件开发的 vscode 插件 配置由于本插件涉及的 code 码是写在注释里面的，需要将 vscode 中的 comments 配置为 on，以响应注释之内的事件，见下图：
备注：进入 vscode 首选项 -> 设置 -> 搜索 edit.quickSuggest -> 将 comments 设置为 on 功能快速注释关键词带出注释可输入'/'或'comment'，带出快速注释的代码块儿，选择对应注释即可，如下图所示
自动识别注释在一些写 pb 常用注释的地方，可以自动识别注释，目前可自动注释的有 service、message、rpc、enum 和字段，如下图所示
(注意：message 上自动识别注释生成的是 respCode 的注释，只是写 code 码才会用到，若自动识别注释无法完全满足所需，建议使用关键词带出注释)
code 码跳转到定义在带有'@code'标签的注释行里，可跳到 code 码的定义处，如下图所示
code 码自动补全在带有'@code'标签的注释行里，会自动识别带有'respCode'标签下面的 code 码的 message 进行补全，补全之后，输入'.'，会自动将该 message 中的字段带出来，如下图所示
code 码 hover 提示信息在带有'@code'标签的注释行里，hover 时，可提示 code 码的信息，对应的 message 会提示整个代码块儿的信息，对应的 code 码字段会提示该行信息，如下图所示
针对整个.proto 文件一键自动生成注释进入到.proto 文件中时，可以右键打开菜单，选择初始化 PB 注释，这时候会对整个文件生成标准化 pb 注释，自动注释生成范围包括 service、rpc、enum 以及 message 下面的字段（不包括自定义对象字段）。如果在带有字段标识的代码上方或者同一行有注释，会将上方的注释或同行的注释（优先带入上一行注释）自动带入到生成的标准注释的@desc 标签中。并且这个功能会自动识别字段的类型以及字段名称，类型为 int32/uint32，且字段不带有['time','date']字段时，会带入 @enum_source 标签，类型为 string，且字段带有['type','status','code','step','gender','level','industry','occupation','match','result','reason','relationship','religion','language','tag','flag','scene','dependent','day','channel','source']，会带入 @enum_source 标签，类型为 int64/uint64，会带入 @range 标签。该功能使用如下图所示：
针对某行代码生成带 desc 的注释我们优化了使用 '/**' 命令针对单行代码自动生成注释的功能，现在在某行代码上输入该命令，会将该行代码的注释自动带入@desc 标签中，并且会识别字段类型以及字段名称来生成不同的注释。具体功能及使用如下图所示：
根据 message 上的@exampleJson 标签，可以自动将注释中的 json 内容填充到对应字段的@example 中为了解决同学们填写示例的困难，我们增强了插件功能，在点击初始化 PB 文件的时候会对 message 也生成默认注释，注释中会带有 @exampleJson 标签，这个标签下会留有空行，同学们只需要导出对应 message 的 json 数据粘贴在这个空行里面，然后右键点击‘自动填充 example’这个按钮，即可将 json 里面的内容自动填充到对应字段的@example 标签中。具体功能及使用如下图所示：
错误提示如果在一行带有标识的代码之上，存在单行注释和多行注释，并且单行注释在多行注释之上，就不符合 API_Map 的解析标准，为避免解析失败，这里会对单行注释在多行注释之上的代码进行错误提示。具体功能及使用如下图所示：
版本v1.0.0v1.0.0 版本为初始版本，完成了快速注释、code 码跳转到定义、自动补全、hover 提示信息这四个功能。可满足基本的使用，后续会持续优化。 v1.1.0v1.1.0 版本对一些常用的较为复杂的注释实现了自动识别添加，不需要如 v1.0.0 那样输入'/'或'comment'再选择注释，只需要在需注释代码上一行输入'/**'并回车，即可自动识别添加对应注释。见下图
v1.2.0v1.2.0 版本支持对整个文件一键生成注释，并且支持在生成注释时将既有的描述填入到@desc 标签中，此外，还会自动检查会导致解析出错的情况并进行错误标记提醒。 针对整个 pb 文件一键自动生成注释
针对某行代码生成带 desc 的注释
错误提示
v1.3.0自动填充 json 中的值到对应字段的 example 中v1.3.0 版本主要是解决注释时字段的 example 填写困难的问题。优化后，现在在初始化 PB 注释时也会对 message 生成注释模版，模版中有 @desc 和 @exampleJson 标签，用户只需要导出 message 对应的 json，将 json 粘贴在 @exampleJson 标签下对应的空行中，然后右键点击 '自动填充 example' 按钮，即可将 json 中对应字段的值填充到字段的 @example 标签中，详情如下：
Publish by Shopee Credit FE |
