方法最佳实践结束时的评论？

Question

我有一些代码在每个方法之后都有注释，例如：

// End of contructor DbFactoryDBConnection()

这样的评论是否应该用于表示方法的结束？这是从早期的就业中获得的东西，它是常见的。

Answer 1

我觉得这样的评论是在身体不适合单个屏幕的方法之后。我相信这是重构和拆分这么长的方法来缩短一些甚至是提取新的实体/服务/帮助的好方法。这就像C＃区域，有时它用于隐藏很长的代码块，这表示你有某种God Object anti-patter。

Answer 2

没有。如果您想知道大括号的结束而不滚动，您可以ReSharper。这在很多方面都很棒。

只需将光标放在大括号上，如果它们的开口不在视图中，它就会在它之前对整行进行工具提示。

Answer 3

通常这种评论是一种过度的文件 评论应该存在的正确位置在您的课程和方法的开头，并且在您的代码中进行重要决策之前。
如果您发现需要记录IF，SWITCH或METHOD的结尾，那么您的代码很可能会被重新检查以简化。

Answer 4

我认为这种评论完全没有必要，只会使代码混乱。大多数IDE（例如Visual Studio）都具有突出显示方法（或其他）多年的功能，因此我不确定通过这样做可以为您的代码添加什么值。

Answer 5

你可以随时使用PowerCommands for Visual Studio，它会在大括号末尾添加评论你使用它的最终结果是什么，它有很多帮助:)

Answer 6

不，不应该使用这样的评论。唯一的原因是，有人会使用这样的评论，因为该方法方式太长。但即便如此，现代IDE还是向您展示了您当前使用哪种方法，甚至允许折叠方法回归到定义 像这样的评论没有任何价值，只是污染了代码库。

Answer 7

这不属于来源恕我直言;与有效的源代码块不同步太容易了。有一些扩展可以在Visual Studio中为您显示此信息，您觉得这很有帮助。