我需要一种方便的方法来在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有生成它的快捷方式?在那儿?将摘要添加到类或方法的简便方法是什么?
答案 0 :(得分:2)
如果您已将项目设置为生成XML文档,则R#将提供为公共成员生成XML注释的选项。
如果您想要从类和方法名称中直接推断文本文档,那么GhostDoc就是您的选择。
如果要为每种方法生成相同的结构,只需定义相应的实时模板或VS片段。
答案 1 :(得分:0)
这是一个较旧的问题,但是替代已接受的答案可能对某些人有所帮助。
将Resharper Stylecop扩展添加到Visual Studio。
一旦安装,您将有机会配置xml文档设置。确保启用“创建XML文档存根”
配置完成后,运行Resharper代码清理并选择Stylecop选项。