说说大家的编程规范

只看该作者 · 2015-7-28 21:08

大家在编程时都有哪些规范呢，我先说说我的一些小规范。。。

只看该作者 · 2015-7-28 21:09

1。程序块要采用缩进风格编写，缩进的空格数为4个
2。相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
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;

只看该作者 · 2015-7-28 21:12

较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied;

act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );

report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)

只看该作者 · 2015-7-28 21:13

循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
示例：
if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item)))
{
... // program code
}

for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)
                  && (j < NewKeyword.word_length); i++, j++)
{
... // program code
}

for (i = 0, j = 0;
   (i < first_word_length) && (j < second_word_length);
   i++, j++)
{
... // program code
}

只看该作者 · 2015-7-28 21:16

若函数或过程中的参数较长，则要进行适当的划分。
示例：
n7stat_str_compare((BYTE *) & stat_object,
               (BYTE *) & (act_task_table[taskno].stat_object),
               sizeof (_STAT_OBJECT));

n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER
                                    + index, stat_object );

只看该作者 · 2015-7-28 21:16

不允许把多个短语句写在一行中，即一行只写一条语句。
示例：如下例子不符合规范。
rect.length = 0; rect.width = 0;
rect.length = 0;
rect.width = 0;

只看该作者 · 2015-7-28 21:19

if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
示例：如下例子不符合规范。
if (pUserCR == NULL) return;

应如下书写：
if (pUserCR == NULL)
{
return;
}

只看该作者 · 2015-7-28 21:20

：对齐只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因 TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用 BC 作为编辑器合版本，因为 BC 会自动将8 个空格变为一个 TAB键，因此使用 BC合入的版本大多会将缩进变乱。

只看该作者 · 2015-7-28 21:28

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求

只看该作者 · 2015-7-28 21:29

程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一
列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以
及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例：如下例子不符合规范。
for (...) {
... // program code
}

if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}

应如下书写。
for (...)
{
... // program code
}

if (...)
{
... // program code
}

void example_fun( void )
{
... // program code
}

只看该作者 · 2015-7-28 21:56

好多的好规范，学习了

只看该作者 · 2015-7-28 22:01

不错不错，学习了

只看该作者 · 2015-7-28 22:20

避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。

只看该作者 · 2015-7-28 22:20

数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须
加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注
释放在此域的右方。
示例：可按如下形式说明枚举/数据/联合结构。
/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not */
/* transmission this message */
N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
};

只看该作者 · 2015-7-31 23:35

不错啊，这么多的好习惯啊

说说大家的编程规范

涓涓之细流

以坛为家

技术奇才奖章