自动插入 XML 注释的 C# 代码工具

Question

我即将接手一个C#项目，前一位开发者通常没有在公共声明前插入XML注释。因此，在构建时我会收到约1000个警告（大多数是由于这个问题）。这种洪水般的警告信息完全掩盖了任何有用的警告信息，所以我想让它消失；同时，一次性编写所有缺失的注释也非常耗时，即使我能轻松地找出所有方法。

我知道我可以在Visual Studio中禁用警告；但我只想让现有代码中的噪音消失。我更希望在忘记为任何新代码添加注释时仍然会被提醒。如果存在这样的功能，我希望能够创建空的占位符注释，在开始处理代码之前关闭现有方法上的警告。

类似这样：

/// <summary>
/// 
/// </summary>
/// <param name="foo"></param>
/// <param name="bar"></param>
/// <param name="baz"></param>
/// <returns></returns>
public int DoStuff(int foo, double bar, string baz)
{
   ...
}

- Dan Is Fiddling By Firelight

Answer 1

试试GhostDoc，我用它来插入这些注释模板。它甚至会根据方法名尝试生成摘要行。

- Jeffrey Hantin

---

它不会为所有1000个警告执行此操作，他必须手动进行。http://weblogs.asp.net/rweigelt/archive/2005/04/15/400951.aspx - Brandon

@Brandon：GhostDoc Pro有一次处理一个文件或一种类型的选项，可能会更快...（换句话说，如果你付钱给他，他会屈服XD） - Jeffrey Hantin

@Brandon：它不会处理所有的1000个左右，但至少可以让他更快地完成这个过程。 - Alex Essilfie

而且，我同意Alex的观点。我自己也使用GhostDoc。我的评论并不是针对答案的负面评价，只是提醒他如果期望一种解决方案来修复类型问题的话，这可能不太适用。 - Brandon

在不得不手动一次性地逐个处理每种方法/属性的情况下；并且不了解应用程序足够多，无法判断自动生成的文本是否有效，我不确定我是否真正获得了有价值的东西。完全空白的注释对其内容没有任何虚假的合法性印记。 - Dan Is Fiddling By Firelight

有没有更现代的工具？GhostDoc不支持VS 2019。 - Eniola

Answer 2

感觉好像已经晚了12年，不过你可以尝试一下cxCommenter

现在它可以执行以下功能：

1. 为 C# 文件添加头部摘要。
2. 添加命名空间摘要。
3. 添加带参数和返回类型的函数摘要。
4. 添加属性摘要。

- Khaled Md Tuhidul Hossain