太多的注释混入程序代码可能会代码难以理解,通常最好是将一个注释块放在所解释代码的上方。
代码改变时,注释与代码保持一致。程序员即使知道系统其他形式的文档已经过期,还是会信任注释,认为它会是正确的。
错误的注释比没有注释更糟,因为它会误导后来者。
一个注释对不能出现在另一个注释对中。由注释对嵌套导致的编译器错误信息容易使人迷惑。
太多的注释混入程序代码可能会代码难以理解,通常最好是将一个注释块放在所解释代码的上方。
代码改变时,注释与代码保持一致。程序员即使知道系统其他形式的文档已经过期,还是会信任注释,认为它会是正确的。
错误的注释比没有注释更糟,因为它会误导后来者。
一个注释对不能出现在另一个注释对中。由注释对嵌套导致的编译器错误信息容易使人迷惑。