文档介绍:代码规范培训
培训目的
统一编码风格
提高代码可读性
提高软件可维护性
节约时间成本
提高软件质量
主要内容
排版风格
注释风格
程序风格
程序效率
代码安全
1、排版风格
主要内容
程序段间空行
较长语句处理
关于短句处理
关于空格使用
程序段间空行
相对独立的程序块之间、变量说明之后必须加空行。
程序段间空行
示例:如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
再如,case语句空格方式,break后要空行
case CMD_A:
ProcessA();
break;
case CMD_C:
ProcessC();
break;
较长语句处理
较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
较长语句处理
示例:
= NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)
&& (n7stat_stat_item_valid (stat_item)));
较长语句处理
循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首