vs2017 快速添加自定义函数注释的方法

￡神魔★判官ぃ 2022-09-10 02:20 432阅读 0赞

我们在给函数 / 文件 做注释时，总是希望有个自己想要的注释模板，而且可以快速添加出来。在 vs 中是可以做到的，这里以 vs2017 为例，详细介绍下使用：

# 1、找到并打开对应 Snippets 目录 #

不同版本的 vs、不同语言，这个目录也都是不一样的。可以通过 “工具” -> “代码片段管理器” -> 选择对应的语言（比如C++）,然后就可以看到对应目录。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_9_color_FFFFFF_t_70_g_se_x_16][]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16][]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 1][]

# 2、创建自定义的.snippet文件 #

在此目录下，需要管理员权限，如果无法创建新文件，就复制一个其他的 .snippet 文件，修改名称为 fuc.snippet , 修改其内容如下并保存：

<?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		: none
     * @in param input_para	: none
     * @out param output_para : none
     * @return : none
     */
                ]]>
                </Code>
            </Snippet>
        </CodeSnippet>
    </CodeSnippets>

在代码中设置快速添加此注释的快捷词（提示词）为 fuc

# 3、导入自定义的.snippet文件模板 #

将 fuc.snippet 导入到 “My Code Snippets” ，（也可以先将 fuc.snippet 拷贝到 “My Code Snippets” 对应的位置目录下），点击导入，选择 fuc.snippet 即可。

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 2][]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_20_color_FFFFFF_t_70_g_se_x_16][]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 3][]

# 4、测速使用 #

在 cpp 文件中输入 fuc 单词时，会自动提示，选择提示的 fuc 即可添加自定义的注释信息了。【注意：输入 fuc 时需要等待一下，反应可能会有些延迟】

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_17_color_FFFFFF_t_70_g_se_x_16][]

![watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_18_color_FFFFFF_t_70_g_se_x_16][]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_9_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/bbd5e685363346eeaf2f33cfc93026b9.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/492b2ee7688b42d3baefe03180f2c6e4.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220829/de9577f5aac44c58b8c34187d27d1a86.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220829/158349f6f3bc45f5931bb9bf546b00a9.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/631eaf82f43a4b8fb10f978fc980eaed.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_19_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220829/8ef3c038c03f4b7183375c043a72f71b.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_17_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/459ed94fbb7f40b78490849b9591f7ef.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6auY56WleGlhbmc_size_18_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/4e7554a232f14a3bb25686d55199fd0a.png