C# 对关闭 {} 的评论

标签 c# devexpress comments

我一直在使用 DevExpress CodeRush 和 Refactor!这周 Pro,我选择了一个评论器插件,它会在您键入代码时自动生成评论。

我不想讨论它在挑选基本含义方面做得有多好(实际上相当好),但它的默认实现确实提出了一个问题。

默认情况下,输入 } 字符关闭 block 将导致插件添加如下注释...

using(MyType myType = new MyType())
{
    myType.doWork();
} // using

(即在右括号标签打开的地方添加注释。)

虽然我可以看到有些情况下此行为可能很有用,但我觉得生成的代码看起来非常不整洁,包含所有额外的注释。

我想知道其他人对这种评论的看法。不仅从学术的角度来看,而且如果我收到大量关于它们的负面评论,我可以决定是将它们强加于我的同事还是将它们剔除。

最佳答案

我认为这样的评论是没有用的,除非代码很糟糕。通过正确格式化代码,不难看出 block 的开始位置和结束位置,因为通常这些 block 是缩进的。

编辑: 如果一个过程太大以至于不能很明显地看出大括号关闭了哪个代码块,那么无论如何应该已经有更多描述该过程的描述性注释,而这些注释只会变得困惑。

关于C# 对关闭 {} 的评论,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/323837/

相关文章:

c# - 编辑 winForm VS2012 时丢失 UserControl

html - JSP 表达式是否在 JSP 页面的 HTML 注释中求值?

javascript - JSDoc 生成文档中的分组函数

javascript - DevExtreme dxList 在鼠标悬停时更改 itemTemplate

c# - 如何跳过 DevExpress ColumnView 的 CellValueChanging 状态?

java - 如何解析css(stylesheet)注释(annotations)?

c# - 在构建中包含数据库文件

c# - 是否有任何工具可以从 XAML 转换为 C#(代码隐藏)?

c# - 如何将 Json 嵌套属性获取到主要属性

c# - C# .Net 2.0 是否有基于规范的测试框架?