2013-12-07 72 views
5

在C#中,我评论的方法是这样的:VC++评论,文件和智能感知

/// <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; 
    } 

这给人很不错的智能感知提示窗口:

enter image description here

什么,如果有的话,是相当于在Visual C++中还是(甚至更好)一种可以在其他IDE(如XCode或Eclipse)中工作的解决方案?

更新

我发现this similar question,但@ edtheprogrammerguy的回答具有很好的参考,所以我会在这里离开这里questino。另外,SO不会让我删除我的问题。

更新第二

很多C#XML注释的(<summary>,例如)工作开箱。如果///评论自动插入了所需的summary,paramreturns标签,但我认为使用新的代码片段实现起来会非常容易。

更新第三

这里的一个代码段插入报头。它不扫描方法参数列表,但这是一个不错的开始。保存为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> 

而且,看到非常漂亮的Code Snippet Designer VS扩展,使创建这些轻而易举。

回答

4

关于通过键入///自动插入注释标记,我写了一个扩展 - CppTripleSlash,你可能会发现有用。