如何在C＃中記錄方法參數？存在像Javadoc的東西？

我在C＃相當新的（我從爪哇來到）如何在C＃中記錄方法參數？存在像Javadoc的東西？

在Java中，我經常使用的javadoc來記錄paramether類型和返回值評論我的方法

喜歡的東西

/* @param an int 
    @param a Rectangle object 
    @return void 
*/ 
    public void myMethod(int i, Rectangle rec){ 
     ............. 
     ............. 
    }

什麼是在C＃中記錄這些事情的約定嗎？

來源

2014-03-13 AndreaNobili

是的，你可以記錄你的代碼，至少Visual Studio支持這一點。在任何類/函數/任何之前使用///來編寫代碼的描述。更多信息在這裏http://msdn.microsoft.com/en-us/library/vstudio/b2s063f7%28v=vs.100%29.aspx – Blablablaster

是的，看看XML文檔。

有MSDN上一個不錯的網頁都是關於它 - http://msdn.microsoft.com/en-us/library/z04awywx.aspx

來源

2014-03-13 10:58:39 Lloyd

您可以使用「<摘要>」標籤。從MSDN

例子：

/// <summary>DoWork is a method in the TestClass class. 
/// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para> 
/// <seealso cref="TestClass.Main"/> 
/// </summary>

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

來源

2014-03-13 10:59:20 ronaldm

默認情況下，Visual Studio中有三回斜槓commenting.When你把上面的函數它會顯示

/// <summary> 
    /// 
    /// </summary>

，你可以寫下你的評論。

如果你想要一些先進的，請從visualstudiogallery.Its一個免費的工具Ghostdoc。

來源

2014-03-13 11:08:27

只需在方法，類，字段等之前插入三個///，然後寫出你想要的內容，甚至可以添加示例，異常等等。一個例子：

/// <summary> 
/// A function summary here. 
/// </summary> 
/// <param name="inParam">An in parameter</param>

來源

2014-03-13 11:39:11

如何在C＃中記錄方法參數？存在像Javadoc的東西？

回答

相關問題