适用于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>

 

posted @ 2016-09-24 12:44  fyter  阅读(4396)  评论(0编辑  收藏  举报