【问题标题】:Can I generate class and method summaries with ReSharper?我可以使用 ReSharper 生成类和方法摘要吗?
【发布时间】:2015-02-27 19:45:24
【问题描述】:

我需要一种方便的方法来在 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 有一个生成它的快捷方式?有没有?将摘要添加到类或方法中的便捷方法是什么?

【问题讨论】:

    标签: c# comments resharper summary


    【解决方案1】:

    如果您已将项目设置为生成 XML 文档,R# 将提供为公共成员生成 XML cmets 的选项。

    如果您想要直接从类和方法名称推断文本文档的东西,那么 GhostDoc 就是您的选择。

    如果要为每个方法生成相同的结构,只需定义相应的 Live Template 或 VS sn-p。

    【讨论】:

      【解决方案2】:

      这是一个较老的问题,但已接受答案的替代方案可能对某些人有所帮助。

      将 Resharper Stylecop 扩展添加到 Visual Studio。

      安装后,您将有机会配置 xml 文档设置。请务必启用“创建 XML 文档存根”

      配置完成后,运行 Resharper 代码清理并选择 Stylecop 选项。

      【讨论】:

        猜你喜欢
        • 2021-12-06
        • 1970-01-01
        • 2016-09-17
        • 2014-08-06
        • 2014-04-30
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多