適用於VS C++環境的注釋代碼段，可以讓你的代碼被使用時有高可讀性的注釋

編碼時，在對高級語言（C#/VB etc）函數的訪問時，經常會有很明確的函數功能提示，參數提示，與返回值提示。微軟的VisualStudio C++集成開發環境同樣有這樣的功能，只是常見開源的代碼很少按照VS的注釋格式編寫。

VS2015中Ctrl+K，Ctrl+B，或工具菜單選擇“代碼片段管理器”，選擇導入，選擇下面這個文件，選擇一個位置，就可以在VS編碼是快速輸入summary（智能提示，輸入su基本就會出現了），TAB，就會有格式化的注釋被鍵入，根據提示輸入注釋的各個部分。TAB可以在格式中切換位置，ENTER完成輸入。

 

將下面文件保存為summary.snippet,用VS的代碼片段管理器導入即可。

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>注釋</Title>
      <Author>Fyter(fyter.cn)</Author>
      <Description>添加規范注釋</Description>
      <Shortcut>summary</Shortcut>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>expression</ID>
          <ToolTip>功能描述</ToolTip>
          <Default>函數</Default>
        </Literal>
        <Literal>
          <ID>pname</ID>
          <ToolTip>功能描述</ToolTip>
          <Default>參數1</Default>
        </Literal>
        <Literal>
          <ID>pdesc</ID>
          <ToolTip>功能描述</ToolTip>
          <Default>參數描述</Default>
        </Literal>
        <Literal Editable="true">
          <ID>returns</ID>
          <ToolTip>參數描述</ToolTip>
          <Default>成功</Default>
        </Literal>
        <Literal Editable="true">
          <ID>return_true</ID>
          <ToolTip>返回true</ToolTip>
          <Default>true</Default>
        </Literal>
        <Literal Editable="true">
          <ID>return_false</ID>
          <ToolTip>返回true</ToolTip>
          <Default>true</Default>
        </Literal>
      </Declarations>
      <Code Language="cpp">
        <![CDATA[/// <summary>
///    $expression$
/// </summary>
/// <param name="$pname$">$pdesc$</param>
/// <returns>
///    $returns$，返回 <c>$return_true$</c>, 否則返回<c>$return_false$</c>.
/// </returns>]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>