关于评论你的代码有什么“硬性规则”？

2018-06-30 13:36:53

我看到了其他问题，但我仍然不满意这个主题的涵盖方式。

我想提取一份完整的列表来检查代码检查中的注释。

我相信人们会说相互抵消的事情。但是，嘿，也许我们可以为每个阵营建立一个名单。对于那些没有评论的人来说，这只是非常短的:)

我有一条关于评论的简单规则：你的代码应该告诉你正在做什么的故事; 你的评论应该告诉你为什么这样做的故事。

这样，我确信谁继承我的代码将能够理解代码背后的意图。

我使用元注释评论公共或受保护的函数，如果我记得的话，通常会打到私有函数。

我评论为什么存在足够复杂的代码块（判断呼叫）。为什么是重要的部分。

我评论说，如果我编写的代码我认为不是最优的，但是我将它留在原因中，因为我无法弄清楚更明智的方式，或者我知道我稍后会重构。

我发表评论以提醒自己或其他人缺少功能或代码中未出现的需求代码（TODO等）。

我评论了解释与类或代码块相关的复杂业务规则。我已经写了几段文字，以确保下一个家伙/加仑知道我为什么写了一百个线上课。

如果评论过期（与代码不匹配），请将其删除或更新。切勿留下不准确的评论。

链接地址: http://www.djcxy.com/p/85281.html