Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>apimap-quick-commentNew to Visual Studio Code? Get it now.

apimap-quick-comment

liqi

|
26 installs
| (0) | Free
for quick comments on protobuf
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

apimap-quick-comment README

这是为快速写pb文件开发的vscode插件

配置

由于本插件涉及的code码是写在注释里面的,需要将vscode中的comments配置为on,以响应注释之内的事件,见下图: 需对vscode进行配置

备注:进入vscode首选项 -> 设置 -> 搜索edit.quickSuggest -> 将comments设置为on

功能

快速注释

关键词带出注释

可输入'/'或'comment',带出快速注释的代码块儿,选择对应注释即可,如下图所示 快速注释

自动识别注释

在一些写pb常用注释的地方,可以自动识别注释,目前可自动注释的有service、message、rpc、enum和字段,如下图所示 (注意:message上自动识别注释生成的是respCode的注释,只是写code码才会用到,若自动识别注释无法完全满足所需,建议使用关键词带出注释) 快速注释

code码跳转到定义

在带有'@code'标签的注释行里,可跳到code码的定义处,如下图所示 code码跳转

code码自动补全

在带有'@code'标签的注释行里,会自动识别带有'respCode'标签下面的code码的message进行补全,补全之后,输入'.',会自动将该message中的字段带出来,如下图所示 code码补全

code码hover提示信息

在带有'@code'标签的注释行里,hover时,可提示code码的信息,对应的message会提示整个代码块儿的信息,对应的code码字段会提示该行信息,如下图所示 code码hover提示信息

版本

v1.0.0

v1.0.0版本为初始版本,完成了快速注释、code码跳转到定义、自动补全、hover提示信息这四个功能。可满足基本的使用,后续会持续优化。

v1.1.0

v1.1.0版本对一些常用的较为复杂的注释实现了自动识别添加,不需要如v1.0.0那样输入'/'或'comment'再选择注释,只需要在需注释代码上一行输入'/**'并回车,即可自动识别添加对应注释。见下图 快速注释

Publish by Shopee Credit FE

  • Contact us
  • Jobs
  • Privacy
  • Terms of use
  • Trademarks
© 2023 Microsoft