2013-12-07 71 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,你可能會發現有用。