我可以使用 ReSharper 生成類和方法摘要嗎

Question

我需要一種方便的方法來在 C# 中生成類或方法摘要的存根。 像這個示例摘要：

public class TestClass
{
    /// <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> 
    public static void DoWork(int Int1)

我無法在 ReSharper 中找到這種開箱即用的功能。 我認為它的重構功能會有它，但他們似乎沒有宣傳它。

也許是因為開箱即用的 Visual Studio 有生成它的快捷方式？ 在那兒？ 將摘要添加到類或方法中的便捷方法是什么？

Answer 1

如果您已將項目設置為生成 XML 文檔，R# 將提供為公共成員生成 XML 注釋的選項。

如果您想要直接從類和方法名稱推斷文本文檔的東西，那么 GhostDoc 就是您的選擇。

如果要為每個方法生成相同的結構，只需定義相應的 Live Template 或 VS 代碼段即可。

Answer 2

這是一個較舊的問題，但已接受答案的替代方案可能對某些人有所幫助。

將 Resharper Stylecop 擴展添加到 Visual Studio。

安裝后，您將有機會配置 xml 文檔設置。 確保啟用“創建 XML 文檔存根”

配置完成后，運行 Resharper 代碼清理並選擇 Stylecop 選項。