Question

我刚刚完成了我的一个应用程序，现在可以进行测试了。但在提交我的申请之前，我想确保在任何需要的地方都使用了适当的评论。虽然我在大多数应用程序中都使用了注释，但这次我意识到我的应用程序非常复杂，因此reviewing the code again和functional understanding的目的我需要适当的评论。我也担心申请中的评论数量我正在寻找的是我们在IPhone开发中需要遵循的标准评论实践请帮助。

Answer 1

好的评论说“为什么”你做了什么，而不是“你做了什么”。

Answer 2

我通常会在以下情况下实施评论，（这绝不是详尽无遗的），任何开发人员审核或调试您的应用程序都会在以下情况下欣赏它们：

当我使用第三方或其他模糊的图书馆时;
在深层嵌套的控制结构中，当它们无法避免时;
在Obj-C中实现我自己的协议时（当它们不明显时）;
一般来说，当某些事情对您和/或潜在的评论者来说并不明显时

编辑：我还建议谨慎实施，如果你没有从帖子中得到它。读取接近评论阈值的代码很烦人。你不想觉得你正在阅读编程书的介绍。

Answer 3

评论和iPhone开发没有什么特别之处。

我个人更喜欢可读（自我记录）代码而不是评论。也就是说，使用有意义的方法和变量名来使代码的目的得到理解。如果仍然无法理解，那么评论可能会有用，但不要让它们太长。长评论的一个问题是它们可能与来源不同步并且会产生误导。

我认为与其他文档源的链接很好，例如stackoverflow问题，bug数据库等。

Answer 4

对我来说，这些是黄金原则：

注释不应该解释代码（使用具有正确名称和缩进的自解释代码）。
不要用不合时宜的评论来侮辱读者的智慧
代码块注释（如果需要解释一个过程，请不要在代码块的每一行使用单独的注释）。

Answer 5

当我评论我的代码时，我表现得好像我有一半机智的程序员坐在我旁边问我“这个代码做了什么，你为什么要这样做？”我会回答一下简单回答。

我对他的回应是我的评论。

// now that we got the data we need lets store it in the Settings Array

// check for NULL if null, change to None Selected

// make sure there is an object here so we dont crash

好的评论做法

5 个答案: