由于工作原因,使用过一段时间的c#,发现c#是具有自动添加函数备注信息的,就想查查vscode能否完成这个功能,经过一段时间的查找资料和研究,将完成的过程写下来,分享以下.
1.下载插件
首先先下载插件koroFileHeader,在vscode中在线下载.
在vscode中插件安装界面直接输入插件名称就可以看到了.大概简介如下:
简介
- VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。
- 插件可以帮助用户养成良好的编码习惯,规范整个团队风格。
- 从2018年5月维护至今, 关闭issue 300+ ,拥有250K+的用户,VSCode图表统计日安装用户100多-400多人,
- 经过多版迭代后,插件支持所有主流语言,灵活方便,文档齐全,食用简单!
- 觉得插件不错的话,就给个Star⭐️吧~
主要功能
- 自动生成文件头部注释,自动更新最后编辑人、最后编辑时间等。
- 一键生成函数注释,支持函数参数自动提取并列到注释中。
- 支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释
- 配置非常灵活方便,各种细节都能配置,可以量身打造适合你的注释。
- 支持所有主流语言, 配置文档非常详细,齐全。
直接选择安装就ok了.
2.环境配置
单击设置按钮,在设置界面打开settings.json(如果没有找到,可以使用快捷键ctrl+shift+p,然后输入setting.json,就可以找到)