你在哪裏放置函數文檔，以便它顯示在intellisense上？

我正在編寫一個庫，我希望將文檔放在我的函數中，以便它將顯示在intellisense中，類似於內置函數的intellisense如何顯示每個參數和函數本身的描述。你如何將文檔放入？它是通過函數中的註釋還是在某個單獨的文件中？你在哪裏放置函數文檔，以便它顯示在intellisense上？

來源

2009-07-16 Alex319

如果你在函數上面鍵入///，它會爲你創建一個很好的xml標題塊 – ThePower 2009-07-16 14:30:54

在函數簽名上方使用XML註釋。

/// <summary> 
    /// Summary 
    /// </summary> 
    /// <param name="param1">Some Parameter.</param> 
    /// <returns>What this method returns.</returns>

GhostDoc插件可以幫助您生成這些內容。

來源

2009-07-16 14:29:26 Brandon

我還建議使用StyleCop for Visual Studio來通過一個項目強制執行一致的文檔/樣式。 – 2009-07-16 14:42:10

@Guard，很好的建議。不一致的文件有時非常痛苦。 – Brandon 2009-07-16 14:57:13

在函數或類上方輸入三個正斜槓「///」，VS將爲您創建樣板註釋。 – northben 2013-06-10 19:03:36

除了需要創建文檔（在項目設置中）以及使用程序集保留生成的XML文件的XML註釋之外。

來源

2009-07-16 14:48:54 Richard

「XML文檔註釋（C＃編程指南） 在Visual C＃中，您可以通過在源代碼中特殊的註釋字段XML標籤爲您的代碼文檔直接在代碼塊之前，他們參考一下。」

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

然後你可以使用沙堡生成CHM文件太多，如果你想

http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx

來源

2009-07-16 14:58:59 smnbss

自動生成在現有方法的頂部三斜線註釋部分，只需將光標放在方法定義上方的空行上並鍵入三個正斜槓（「///」）即可。 Visual Studio將自動生成與您的方法相對應的三斜槓註釋。它將包含摘要，每個參數（如果有）和返回值（如果有）的佔位符。你只需填寫空白。

我會建議你不要試圖手寫這些描述塊，而不是從一種方法複製到另一種。第三方工具也沒有必要生成它們（至少在Visual Studio 2010中）。

來源

2013-03-07 18:41:01

你在哪裏放置函數文檔，以便它顯示在intellisense上？

回答

相關問題