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

Question

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

// End of contructor DbFactoryDBConnection()

是否应该使用这样的注释来指示方法的结束？这是从以前很常见的工作中学到的东西。

score 4 · Accepted Answer

我觉得这样的评论是在身体不适合单个屏幕的方法之后。我相信这是重构和拆分如此长的方法以缩短方法甚至提取新实体/服务/助手的好兆头。这就像 C# 区域，有时它被用来隐藏很长的代码块，这表明你有某种上帝对象的反模式。

score 2 · Accepted Answer

不。如果您想知道大括号关闭的是什么，而无需滚动，您可以使用ReSharper。这在很多方面都很棒。

只需将光标放在大括号上，如果看不到它们的开口 - 它会提示它前面的整行。

score 2 · Accepted Answer

通常这种评论是过度文档化的麻烦。
注释应该存在的正确位置是在您的类和方法的开头，并且就在您的代码中将做出重要决定之前。
如果您发现需要记录 IF、SWITCH 或 METHOD 的结尾，那么很可能应该重新检查您的代码以简化代码。

score 1 · Accepted Answer

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

score 1 · Accepted Answer

你总是可以使用 PowerCommands for Visual Studio 它在大括号的末尾添加评论你在什么大括号结束我使用它，它有很大帮助:)

score 0 · Accepted Answer

不，不应该使用这样的评论。有人会使用这样的评论的唯一原因是该方法太长了。但即便如此，现代 IDE 会在某处向您展示您当前使用的方法，甚至允许将方法折叠回定义。
像这样的评论毫无价值，只会污染代码库。

score 0 · Accepted Answer

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

7 回答 7