2011-02-01 80 views
2

我即将接管一个C#项目,该项目以前的开发人员通常不会在公共声明前插入xml注释。因此,当我建立时,我得到了〜1000个警告(最常见的原因是这个问题)。这洪水完全掩盖任何有用的警告信息,所以我想让它消失;同时,即使假设我能够轻易地找出所有这些方法,但立即写下完整的缺失评论也是非常耗时的。在C#代码中自动插入xml注释的工具

我知道我可以只在视觉工作室禁用警告;但我只想让噪音远离现有的代码。我更愿意提醒我什么时候忘记为我写的任何新代码添加注释。如果它存在,我希望能够创建空的占位符注释,以关闭现有方法的警告,然后再开始对代码执行其他任何操作。

事情是这样的:

/// <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) 
{ 
    ... 
} 

回答

7

尝试GhostDoc - 我用它来插入这些注释的模板。它甚至会根据方法名称在摘要行中插入文字。

+0

尽管它不会为所有1000个警告做,但他必须通过手动操作。 http://weblogs.asp.net/rweigelt/archive/2005/04/15/400951.aspx – Brandon 2011-02-01 22:21:02