注释的注意点

在注释中，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应该避免提供代码中已清晰表达出来的重复信息。多余的注释很容易过时。通常应避免那些代码更新就可能过时的注释。注意：频繁的使用注释有时反应出代码的低质量。当你觉得被迫注释的时候，考虑一下重写代码使其更清晰。注释不应写在用星号或其他字符画出来的大框里。注释不应包括制表符和回退符之类的特殊字符。