注释的最佳位置
对代码的注释应放在其上方相邻位置,不可放在下面。
对数据结构的注释应放在其上方相邻位置,不可放在下面。
对结构中的每个域的注释应放在此域的右方。
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。
保持注释与其描述的代码相邻,即注释的就近原则。
简而言之,注释要写在上面或右面。
对代码的注释应放在其上方相邻位置,不可放在下面。
对数据结构的注释应放在其上方相邻位置,不可放在下面。
对结构中的每个域的注释应放在此域的右方。
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。
保持注释与其描述的代码相邻,即注释的就近原则。
简而言之,注释要写在上面或右面。