用于在C#代码中自动插入xml注释的工具

时间:2011-02-01 22:18:15

标签: c# visual-studio-2010

我即将接手一个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)
{
   ...
}

1 个答案:

答案 0 :(得分:7)

试试GhostDoc - 我用它来插入这些评论模板。它甚至会根据方法名称进行汇总。