VC++注释,文档和IntelliSense

3Da*_*ave 5 c++ intellisense comments visual-c++

在C#中,我评论这样的方法:

    /// <summary>
    /// Does absolutely nothing
    /// </summary>
    /// <param name="a">First useless parameter</param>
    /// <param name="b">Second useless parameter</param>
    /// <returns>zero</returns>
    public int Foo(int a, int b)
    {
        return 0;
    }
Run Code Online (Sandbox Code Playgroud)

这提供了非常好的IntelliSense提示窗口:

在此输入图像描述

什么,如果有的话,在Visual C++或(甚至更好)的解决方案中是等效的,可以在其他IDE如XCode或Eclipse中使用?

更新

我发现了类似的问题,但是@ edtheprogrammerguy的答案有很好的参考,所以我将把questino放在这里.此外,SO不会让我删除我的问题.

更新第二个

许多C#XML注释(<summary>例如)开箱即用.这会是很好,如果///注释自动插入必需的summary,param并且returns标签,但我想,这将会是很容易用新的代码片段来实现.

更新第三个

这是一个插入标题的代码片段.它不扫描方法参数列表,但它是一个很好的开始.保存Documents\Visual Studio 2012\Code Snippets\Visual C++\My Code Snippets为带.snippet扩展名的任何内容,重新启动VS,然后summ在方法上方键入+ TAB 激活.

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
      <Title>SnippetFile1</Title>
      <Author>dlively</Author>
      <Description>Insert a summary/param/return header for a method</Description>
      <HelpUrl>
      </HelpUrl>
      <Shortcut>summ</Shortcut>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="true">
          <ID>summary_text</ID>
          <ToolTip>summary_text</ToolTip>
          <Default>Insert description of method</Default>
          <Function>
          </Function>
        </Literal>
        <Literal Editable="true">
          <ID>returns_text</ID>
          <ToolTip>returns_text</ToolTip>
          <Default>Description of return value</Default>
          <Function>
          </Function>
        </Literal>
        <Literal Editable="true">
          <ID>parameter_name</ID>
          <ToolTip>parameter_name</ToolTip>
          <Default>Name of the parameter</Default>
          <Function>
          </Function>
        </Literal>
        <Literal Editable="true">
          <ID>parameter_description</ID>
          <ToolTip>parameter_description</ToolTip>
          <Default>Description</Default>
          <Function>
          </Function>
        </Literal>
      </Declarations>
      <Code Language="cpp" Kind="method decl"><![CDATA[/// <summary>
/// $summary_text$
/// </summary>
/// <param name="$parameter_name$">$parameter_description$</param>
/// <returns>$returns_text$</returns>]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>
Run Code Online (Sandbox Code Playgroud)

此外,请参阅非常好的Code Snippet Designer VS扩展,这使得创建这些变得轻而易举.

edt*_*guy 3

它用于从源文件生成文档。编译/doc器选项将使其生成 .xdc 文件,该文件可以转换为 .xml 文档文件。VC++ 在 Intellisense 方面不如 C# 那么好。

参考:

http://msdn.microsoft.com/en-us/library/ms177227.aspx

http://msdn.microsoft.com/en-us/library/ms173501.aspx