<分区>
如何对源代码进行良好的记录/注释？有没有工具可以在 Unix 平台上为 C++ 生成注释框架？
一般情况下，一个100行左右代码的文件推荐多少行注释？
<分区>
如何对源代码进行良好的记录/注释？有没有工具可以在 Unix 平台上为 C++ 生成注释框架？
一般情况下，一个100行左右代码的文件推荐多少行注释？
最佳答案
一般来说，最好让代码本身解释它做什么，而注释则用来描述为什么它是这样的。没有数字可以坚持。如果您的 100 行不言自明，请完全不要评论或只在开头提供摘要。如果涉及的知识超出了代码的范围，请在评论中进行解释。
如果您的代码太复杂而无法 self 解释，那么这可能是重构的理由。
这样，当您更改实现时，您不需要也更改注释，因为您的注释不会复制代码。由于设计的原因很少改变，为了清楚起见，将它们记录在评论中是安全的。
关于c++ - 源代码中的注释，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/750464/