【问题标题】:How to strip out robo-comments and #region from C#?如何从 C# 中删除 robo-comments 和 #region?
【发布时间】:2010-10-31 17:46:39
【问题描述】:

我正在维护一些代码,其中包含大量机器生成的 cmets 和机器生成的区域。 (或由特别被误导的开发人员创建)

这些是专门重复帕斯卡大小写名称的方法元数据和空间扩展的 cmets:

#region methods
/// <summary>
/// Implementation of a public method foo bar, returning a void
/// </summary>
/// <param name="value">A string parameter named value input</param>
public void fooBar(string valueInput)
{

}
#endregion

是否有 Resharper 的插件或功能可以批量去除 cmets 和 #region 标签?

【问题讨论】:

    标签: c# visual-studio comments resharper visual-studio-addins


    【解决方案1】:

    我投票赞成你在遇到它们时进去修复它们。我不得不在这里做同样的事情......每次我进入一个有坏 cmets 的班级(在我的情况下:没有)。我在使用它们时评论方法/属性。 3 周后,我已经正确评论了大约 1/2 的代码库,并且对整个项目有了更深入的了解。

    【讨论】:

      【解决方案2】:

      我会说用更明智的东西替换它们比将它们剥离要好得多。尽管它们可能很平凡,但没有 cmets 总是更糟(除非 cmets 当然是不正确的?那么没有 cmets 肯定更好):-)

      也就是说,我相信this does what you're looking for

      对于区域标签,您可以尝试调整该应用程序或使用 VS 的正则表达式查找/替换。

      【讨论】:

        【解决方案3】:

        为什么不在 Visual Studio 中使用正则表达式查找和替换?

        对于三斜线 cmets:

         ///.*
        

        对于地区标签:

         [#]区域。*
            [#]结束区域
        

        【讨论】:

          【解决方案4】:

          这些部分很可能是手写的:

          一个公共方法foo bar的实现,返回一个void

          一个名为值输入的字符串参数

          如果这是在类库项目中,我不会摆脱 xml cmets - 它们将显示在这些项目的智能感知提示中。删除它们可能会让其他开发人员对你非常生气;因为这里的所有文字都不是很好,默认提示是神秘的,甚至更糟。

          【讨论】:

          • 我知道,我是手写的。我不会在 SO 上发布真正的源代码。我是唯一的开发者。 Intellisense 已经提供了关于未注释方法的元数据。
          • 大体上同意,但在这种情况下,我认为 XML cmets 并没有增加太多。它真的应该更多地说明它在做什么。
          猜你喜欢
          • 1970-01-01
          • 1970-01-01
          • 2014-10-16
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 2019-05-20
          • 2020-07-30
          • 2019-10-16
          相关资源
          最近更新 更多