巧用VA Snippet Editor (番茄助手)自动添加函数说明

之前一直没怎么用 VAssistX,因为一直做硬件开发,写的都是单片机之类的程序,所以VS的开发环境用的不是很多,直到AVRStudio5,AVRStudio5 用的是VS2010的shell而且默认就已经安装了VAssistX所以写程序的时候自动完成、代码提示这些功能用的非常爽。平时写程序的时候为了规范通常会需要对函数或者文件添加一些注释说明比如:

/*******************************************************************************
名称:void GPIO_init()
功能:初始化对应的输入输出端口
参数:无
时间:
版本:1.0
注意:需要注意引脚设定的第二功能
*******************************************************************************/

通过VA Snippet Editor 可以设置很方便的自动完成这个功能,而且还支持自定义,因此可以根据自己的习惯配置适合自己的。设置方法如下:

打开Visual Assist X Options-Advanced-Suggestions选择Edit VA Snippets会弹出一个窗口,窗口分为左右两部分,左侧是shortcut,这个我不知道怎样描述,我的理解就是在输入程序的时候开始提示的那个字符,可以自己添加也可以自己修改,我找到/*-这个选项,然后编辑右侧,这样在输入程序的时候输入/*-就会自动提示右侧编辑的内容,右侧我输入

/*******************************************************************************
名称:$end$
功能:
参数:无
时间:$MONTH$/$DAY$/$YEAR$ %USERNAME%
版本:1.0
注意:
*******************************************************************************/

里面加了一些参数$end$表示插入文本后结束的地方,也就是在输入/*-就会自动提示这段话,enter插入后光标会停到这个地方。

$MONTH$/$DAY$/$YEAR$ %USERNAME%这个不用解释了,会自动的插入系统日期和用户名。

这样就能很方便的插入自定义的提示代码了,其他的可以按照这个来编辑。

在 Visual Studio 2019 中,你可以使用自定义代码片段来实现为 C++ 函数添加自定义函数注释的目的。以下是一种常用的方法: 1. 打开 Visual Studio 2019,进入你的 C++ 项目。 2. 在 "工具"(Tools)菜单中选择 "代码片段管理器"(Code Snippet Manager)。 3. 在弹出的 "代码片段管理器" 窗口中,选择 "Visual C++"。 4. 点击 "添加"(Add)按钮,然后选择 "新建代码片段"(New Code Snippet)。 5. 在弹出的对话框中,选择 "Visual C++",然后点击 "下一步"(Next)。 6. 在 "代码片段编辑器"(Snippet Editor)中,输入以下代码: ```cpp <?xml version="1.0" encoding="utf-8"?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format="1.0.0"> <Header> <Title>函数注释模板</Title> <Shortcut>fncomment</Shortcut> <Description>自定义的函数注释模板</Description> <Author>你的名字</Author> <SnippetTypes> <SnippetType>Expansion</SnippetType> </SnippetTypes> </Header> <Snippet> <Code Language="cpp"><![CDATA[ /** * @brief 函数的简要描述。 * * @param 参数名 参数的描述。 * @return 返回值的描述。 */ $end$]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets> ``` 7. 将代码中的 `"你的名字"` 替换为你的名字或其他适当的注释。 8. 点击 "文件"(File)> "保存"(Save),然后选择一个保存位置和文件名,比如 "FunctionComment.snippet"。 9. 关闭 "代码片段编辑器" 窗口。 10. 在你的 C++ 代码中,定位到你想要添加函数注释函数,并输入 "fncomment"(或者你在代码片段中指定的自定义快捷方式)。 11. 按下 "Tab" 键,代码片段将自动展开并插入自定义的函数注释模板。 这样,你就可以使用自定义的函数注释模板快速添加注释到你的 C++ 函数中了。每次你输入指定的快捷方式并按下 "Tab" 键时,都会插入你定义的函数注释模板。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值