如何自定义 Resharper 的“代码清理”以​​更改 C# 中的文档标题规则

Posted 2023-03-31

【中文标题】如何自定义 Resharper 的“代码清理”以​​更改 C# 中的文档标题规则

【英文标题】：How to customize Resharper's "code clean up" to change the documentation header rules in C#

【发布时间】：2011-08-19 00:46:26

【问题描述】：

我想通过以下方式使用代码清理自动创建文档标题：

/// <summary>
/// **Some summary.**
/// </summary>
/// <param name="myParam">**The param.**</param>
/// <typeparam name="TService">**The type.**</typeparam>
/// <returns>**Whatever.**</returns>
TService Do<TService>(int myParam)

也就是说，摘要有多行，但其余字段使用单行。目前我的默认 resharper 设置总是使用多行。

在 Resharper“代码清理”中控制此行为的规则集是什么？有可能吗？

【问题讨论】：

我知道这很容易忘记，但请在发帖时使用代码格式。

谢谢，迈克，当你打败我时，我实际上正在这样做。

【参考方案1】：

Resharper 的代码清理不会这样做，但您可以使用GhostDoc。它甚至可以为很多常用方法（构造函数、事件处理程序、属性等）编写正确的 cmets。

【参考方案2】：

我不会创建 XML doc cmets，只会重新格式化它们。

它会更新文件头...