2009-07-02 24 views
0

我完成了一些我的第一個C#類,即使我繼承的原始代碼完全沒有評論,我總是把javadoc評論放在我的方法時,我正在寫java和我的代碼目前看起來很奇怪沒有這些塊。評論樣式(即Javadocing C#版本) - (Java開發人員學習C#)

我通常在Eclipse中使用「插入JavaDoc」命令來格式化我的註釋,該命令只是簡單地佈置模板並從運行該命令的方法中拉入參數,方法名稱等等。然後我可以從那裏添加更多細節。

在Visual Studio 2008中是否有類似的命令?當我在菜單週圍摸索時,我找不到一個。另外,在C#世界中是否有標準的評論風格約定(類似於JavaDoc)?

回答

6

如果您鍵入///,IDE編輯器會自動爲您生成一個空的XML註釋。

此:

/// 
public QName(String qName, XmlNode contextNode) { 

變爲這樣:

/// <summary> 
/// 
/// </summary> 
/// <param name="qName"></param> 
/// <param name="contextNode"></param> 
public QName(String qName, XmlNode contextNode) { 

如果你的方法拋出,你必須手動添加標籤,因爲.NET沒有聲明的異常任何異常。最後的評論:

/// <summary>Creates a new QName from a string with the format 
/// <c>prefix:local-name</c> or <c>local-name</c>.</summary> 
/// 
/// <param name="qName">A QName string.</param> 
/// <param name="contextNode">An XML node from which to lookup the namespace 
/// prefix, or <c>null</c>.</param> 
/// 
/// <exception cref="XmlInvalidPrefixException">Thrown if the prefix cannot be 
/// resolved from the lookup node. If <paramref name="contextNode"/> is 
/// <c>null</c>, then the only prefix that can be resolved is <c>xml</c>. 
/// </exception> 
public QName(String qName, XmlNode contextNode) { 
1

型三前鋒的任何方法之前斜線:

/// 

這將生成一個XML註釋塊。

1

如果在Visual Studio中的某個方法之前鍵入三個正斜槓「///」,它將自動爲您創建一個簡單的模板以評論方法。 (它會爲你創建字段,以便對參數和返回值進行評論。)我認爲這很好,因爲它很快捷,但可能需要更深入的東西。

1

在C#中,如果您在要評論的內容之上輸入三個斜線,它將自動爲目標插入適當的文本。

它將包括一個總結,參數(如果有的話),回報(如有)等

/// 

然後,您可以使用類似NDoc採取這些意見,並建立API文檔出來。

1

有一個免費的附加在Visual Studio中,GhostDoc,這將有助於你建立了C#XML文檔的基本結構,提供多一點///將讓你從Visual Studio本身。

相關問題