注释与所描述内容可不同的缩排。
将注释与其上面的代码用空行隔开。
将注释与其上面的代码用缩进隔开。
对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
对变量的定义必须编写注释,分支语句(条件分支、循环语句等)可不必编写注释。
对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,无需在该case语句处理完、下一个case语句前加上明确的注释。
标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
标识符的命名要清晰、明了,有明确含义,同时使用完整的单词,不可使用缩写,避免使人产生误解。
命名中若使用特殊约定或缩写,则要有注释说明。
命名中若使用特殊约定或缩写,不必有注释说明。
自己特有的命名风格,要自始至终保持一致,不可来回变化。
自己特有的命名风格,要自始至终保持一致,允许多种变化。
对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
对于变量命名,可以取单个字符(如i、j、k...),作局部循环变量也是允许的。