vs2017添加自定义快速注释

目录

1、打开“添加自定义快速注释”窗口

2、找到需要进行添加的语言

 3、创建自定义快速注释（.snippet格式文件）

 4、导入自定义快速注释

5、使用

---

函数和cpp文件一般需要添加一些注释，方便使用和提高他人的可读性，固定格式的注释会让代码更加整洁，但是手动写比较慢，所以添加自定义快速注释有利于我们提高开发效率。

1、打开“添加自定义快速注释”窗口

找到“工具-代码片段管理器”即可打开，如下图所示:

2、找到需要进行添加的语言

这里我是进行c++开发，所以选择“Visual C++”，可自行根据自己的语言进行添加

自定义快速注释一般保存在“My Code Snippets”文件里面，可以直接复制路径打开文件在里面创建自定义格式的注释

 3、创建自定义快速注释（.snippet格式文件）

自定义快速注释文件的格式是.snippet的，按照以下格式创建文件：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets>
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>标题</Title>
			<Shortcut>输入快捷提示词</Shortcut>
		</Header>
		<Snippet>
			<Code Language="cpp"><![CDATA[
具体注释内容
            ]]></Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

 创建好后如下图所示:

 这里提供一些我自己使用的自定义注释：

（1）函数简洁注释

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets >
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>fuc</Title>
            <Shortcut>fuc</Shortcut>
        </Header>
        <Snippet>
            <Code Language="cpp"><![CDATA[
/***
 * @brief: 

 */
            ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

（2）函数完整注释

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets >
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>fucall</Title>
            <Shortcut>fucall</Shortcut>
        </Header>
        <Snippet>
            <Code Language="cpp"><![CDATA[
/********************************************************************
Function: //函数名称 
Descption: //函数功能、性能等的描述 
Calls: //被本函数调用的函数清单 
Called By: //调用本函数的函数清单 
Table Accessed: //被访问的表（仅对牵涉到数据库操作的程序） 
Table Updated: //被修改的表（仅对牵涉到数据库操作的程序） 
Input: //输入参数说明，包含每个参数的作用、取值说明及参数间关系 
Output: //对输出参数的说明 
Return: //函数返回值的说明 
Author://作者
Others: //其他说明 
********************************************************************/ 

            ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

（3）cpp文件模块注释

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets >
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>cppinfo</Title>
            <Shortcut>cppinfo</Shortcut>
        </Header>
        <Snippet>
            <Code Language="cpp"><![CDATA[
/************************************************************** 
Copyrite (C), 1998-1999, Huawei Tech.Co., Ltd.
FileName: <FileName>.cpp 
Author: 
Date: 
Description: //模块描述
Version: //版本信息
Function List: //主要函数及其功能
1：--------------
2：--------------

History: //历史修改记录 
<Author> <time> <version> <description> 
David 1996/10/12 1.0 bulid this module 
**************************************************************/
            ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

 4、导入自定义快速注释

（1）选择“My Code Snippets”，点击“导入”按钮

（2）选择文件并导入

 

导入成功后可以在“代码片段管理器”中看到刚才导入的文件；如果没有看到，重新打开窗口就会有了，如下图所示：

5、使用