2014-03-03 53 views
2

在C#中,XML註釋以三個正斜槓(///)開頭。例如:C#三個正斜槓:模板可以更改嗎?

/// <summary> 
/// 
/// </summary> 
/// <param name="sender"></param> 
/// <param name="e"></param> 

是否有任何方法可以更改生成的註釋,例如添加其他標記?我認爲可能有一個定義XML的片段文件,但我找不到一個。誰能幫忙?

更新:據我所知,現有的question的第一個答案只是提供了一個插入代碼的片段。具體來說,summ + tab + tab插入摘要行。它似乎並不涉及改變由///插入的XML,這正是我正在尋找的。

對該問題的其他答案表示可以使用宏InsertDocComments完成(但我不認爲這是///調用的內容,或者我不知道如何導致它),另一個答案表示它不能完成。所以,如果它真的不能完成,哦,但我仍然希望。

+0

正如阿里納斯了StyleCop的片段於此的是RA它很好,因爲它們包括拋出的異常。 – Magus

+0

「重複」看起來很相似,但與我的問題確實沒有任何關係。我會編輯這個問題以明確區別。 – Qodex

回答

0

我使用GhostDoc這是一個免費的Visual Studio擴展,當您在一個符號上按[Ctrl] + [Shift] + D時,它會自動生成xml文檔。

據我所知,你不能覆蓋默認///行爲

如果沒有外部軟件的幫助下,你可以創建自己的自定義代碼段,這其中有ccc

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
    <CodeSnippet Format="1.0.0"> 
    <Header> 
     <Title>Slashes</Title> 
     <Author>Benjamin Thomas Blodgett</Author> 
     <Shortcut>ccc</Shortcut> 
     <Description>Creates xml documentation</Description> 
    </Header> 
    <Snippet> 
     <Code Language="csharp"> 
     <![CDATA[/// <summary></summary> 
/// <AnotherTag></AnotherTag> 
/// <param name="sender"></param> 
/// <param name="e"></param>$end$]]> 
     </Code> 
    </Snippet> 
    </CodeSnippet> 
</CodeSnippets> 
快捷方式

走這條路的時候,你可以隨時還可以添加標籤,停止,因爲我已經把下面

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
    <CodeSnippet Format="1.0.0"> 
    <Header> 
     <Title>Slashes</Title> 
     <Author>Benjamin Thomas Blodgett</Author> 
     <Shortcut>ccc</Shortcut> 
     <Description>Creates xml documentation</Description> 
    </Header> 
    <Snippet> 
     <Declarations> 
     <Literal> 
      <ID>summary</ID> 
      <Default>Summary...</Default> 
     </Literal> 
     <Literal> 
      <ID>anothertag</ID> 
      <Default>Another Tag's Value...</Default> 
     </Literal> 
     <Literal> 
      <ID>sender</ID> 
      <Default>Sender Description...</Default> 
     </Literal> 
     <Literal> 
      <ID>event</ID> 
      <Default>Event Args...</Default> 
     </Literal> 
     </Declarations> 
     <Code Language="csharp"> 
     <![CDATA[/// <summary> $summary$ </summary> 
/// <AnotherTag> $anothertag$ </AnotherTag> 
/// <param name="sender"> $sender$ </param> 
/// <param name="e"> $event$ </param>$end$]]> 
     </Code> 
    </Snippet> 
    </CodeSnippet> 
</CodeSnippets>