【发布时间】:2015-05-21 08:02:58
【问题描述】:
我喜欢干净的“0 个警告”——C# 中的项目。这包括我的项目,每个公共属性和类都有 XML cmets。
现在我使用实体框架和迁移(代码优先)。迁移是使用“Add-Migration”创建的,这会导致在 Migrations 文件夹中生成自动代码(标准行为)。我可能想要/需要稍微修改这些类,但不想为那里创建的公共类添加注释。
我知道我可以使用 #pragma disable 禁用警告,但我不想对每个迁移类都这样做。
那么:有没有可能在一个完整的文件夹或命名空间上使用#pragma disable(或类似的东西)?
我不想使用 GhostDoc 之类的解决方法。
【问题讨论】:
-
小建议:修复所有警告。
-
你可能是对的。但是,如果我必须评论的不是我创建的代码而是由 VS 创建的代码,那感觉就像是技术的奴隶。好吧,它不是 Cyberdyne(还),但仍然很烦人,感觉非常“不聪明”:)
-
属性上的 XML cmets 极大地降低了可读性,并且任何优秀的开发人员都会阅读您的代码,而不是生成的注释文档。所以关闭 XML 文档的生成,从而消除所有此类警告并专注于编写可读代码。
-
我确实不使用生成的 XML cmets,而是在那里手动添加有用的信息。 (我同意生成的 cmets 是垃圾,这就是为什么我不想要 GhostDoc 之类的东西)。我个人认为 XML cmets 有很大的好处,特别是因为这些信息将显示在 Intellisense 上。我知道有两种类型的开发人员。使用 XML cmets 和不使用 XML cmets 的人。但是,利弊讨论会让我几乎“宗教化”,并且对 SO,尤其是对我的问题来说,是过时的。
-
@DavidArno 我们不要忘记库开发人员,例如,他们需要为其他开发人员的客户评论他们的代码。
标签: c# entity-framework visual-studio pragma xml-comments