样式cop + 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选项，工具，然后是Resharper的StyleCop。在那里，您应该会看到一个复选框，用于使用单行作为声明标头。

Answer 2

试一试GhostDoc。这个免费的Visual Studio扩展会生成更好的XML文档注释。param和return标记是内联的，而summary标记保留在单独的行中。也许这已经适合你的需要了。

Answer 3

如果您在"C#“类别下的默认代码清理设置中关闭了”重新格式化嵌入的XML文档注释“，则可以使GhostDoc工作。然后在StyleCop部分下，关闭规则"1611:元素参数必须记录“和规则"1618:泛型类型参数必须记录”。这样一来，代码清理就不会再破坏你的GhostDoc注释了。请记住，代码清理选项是特定于解决方案的。