方法最佳实践末尾的注释
本文关键字：注释 最佳 方法 | 更新日期: 2023-09-27 18:31:55
>我有一些代码，每个方法后面都有注释，例如：
// End of contructor DbFactoryDBConnection()
是否应该使用这样的注释来指示方法的结束？这是从早期的工作中捡到的东西，那里很常见。
我觉得这样的评论是在正文不适合单个屏幕的方法之后。我相信这是重构和拆分如此长的方法以缩短甚至提取新实体/服务/助手的好兆头。这就像 C# 区域，有时它用于隐藏很长的代码块，这表明您有某种上帝对象反模式。
No.如果你想知道大括号正在闭合什么，而不滚动，你可以使用ReSharper。这在很多方面都很棒。
只需将光标放在大括号上，如果它们的开口不在视图中 - 它会在它之前使用工具提示整行。
通常这种评论是一种过度文档化的麻烦。
注释应该存在的正确位置是类和方法的开头，以及代码中做出重要决策之前。
如果你发现需要记录IF，SWITCH或METHOD的结尾，那么很可能应该重新检查你的代码以简化。
我认为这种注释是完全没有必要的，只会使代码混乱。多年来，大多数 IDE（例如 Visual Studio）都具有突出显示方法范围（或其他）的功能，因此我不确定通过这样做可以添加代码的价值。
您可以随时使用适用于Visual Studio的PowerCommand，它在大括号末尾添加注释您在哪个护腕端我使用它，它有很大帮助：）
不，不应使用此类注释。有人会使用这样的注释的唯一原因是该方法太长了。但即便如此，现代 IDE 也会向您显示您当前所处的方法，甚至允许将方法折叠回仅定义。
像这样的注释没有任何价值，只会污染代码库。
恕我直言，这不属于源代码; 很容易与有效的源代码块不同步。有一些扩展将在Visual Studio中为您显示此信息，我认为这很有帮助。