风格警察+ resharper控制评论

Question

这可能看起来像一个微不足道的问题但是当我为resharper安装了stylecop插件时，我的评论会被格式化为这样

/// <summary>
/// Gets the gift item.
/// </summary>
/// <param name="uid">
/// The uid.
/// </param>
/// <param name="upc">
/// The upc.
/// </param>
/// <returns>
/// </returns>
Gift GetGift(long uid, string upc);

而不是

/// <summary>Gets the gift item.</summary>
/// <param name="uid">The uid.</param>
/// <param name="upc">The upc.</param>
/// <returns></returns>
Gift GetGift(long uid, string upc);

我似乎无法找到任何方法来关闭此类型的格式。

Answer 1

如果您在Resharper中安装了Microsoft Stylecop for Resharper插件，请转到Resharper选项，工具，然后使用StyleCop for Resharper。在那里你应该看到一个复选框，用于声明标题的单行。

Answer 2

尝试GhostDoc。这个免费的Visual Studio扩展可以生成更好的XML文档注释。内联param和return标记，而summary标记保留在不同的行中。也许这已经适合您的需求。

Answer 3

如果在“C＃”类别下的默认代码清理设置中关闭“重新格式化嵌入式XML文档注释”，则可以使GhostDoc正常工作。然后在StyleCop部分下，关闭规则“1611：元素参数必须记录”并且规则“1618：必须记录通用类型参数”。这样代码清理不会重新破坏你的GhostDoc评论。请记住，代码清理选项是特定于解决方案的。