这些小活动你都参加了吗?快来围观一下吧!>>
电子产品世界 » 论坛首页 » DIY与开源设计 » 电子DIY » 碎雨花 MCU DIY进程帖 程序编程规范 一

共3条 1/1 1 跳转至

碎雨花 MCU DIY进程帖 程序编程规范 一

菜鸟
2011-12-11 12:28:56     打赏
         大家经常看别人的代码比较不习惯,如果大家编程都是很规范的编程的话,那就程序清晰明朗。这是我的一些编程心得。 编码规范第一、能使你的代码更加易于维护,程序并不是一次性的产品,它需要扩展和修改还有维护的。但是进行这种操作的人并一定就是你了,所以你为了你的接班人也要将规范编码进行到底!
     1 软件程序排版 1-1:程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 1-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; 1-3:较长的语句(>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)                       && (n7stat_stat_item_valid (stat_item))                       && (act_task_table[taskno].result_data != 0)); 1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。 示例: 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 } 1-5:若函数或过程中的参数较长,则要进行适当的划分。 示例: 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 ); 1-6:不允许把多个短语句写在一行中,即一行只写一条语句。 示例:如下例子不符合规范。 rect.length = 0; rect.width = 0;   应如下书写 rect.length = 0; rect.width = 0; 1-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 示例:如下例子不符合规范。 if (pUserCR == NULL) return;   应如下书写: if (pUserCR == NULL) {     return; } 1-8:对齐只使用空格键,不使用TAB键。 说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。 1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。 1-10:程序块的分界符(如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 } 1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。   示例: (1) 逗号、分号只在后面加空格。 int a, b, c;   (2)比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;   (3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。 *p = 'a';        // 内容操作"*"与内容之间 flag = !isEmpty; // 非操作"!"与内容之间 p = &mem;        // 地址操作"&" 与内容之间 i++;             // "++","--"与内容之间   (4)"->"、"."前后不加空格。 p->id = pid;     // "->"指针前后不加空格   (5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。 if (a >= b && c > d) 注:一行程序以小于80字符为宜,不要写得过长。



关键词: 碎雨     进程     程序     编程     规范     操作     空格     prog    

专家
2011-12-11 12:50:21     打赏
2楼
编写代码有一个规范!!也能让人家看的清楚

高工
2011-12-11 13:19:05     打赏
3楼
每个人的编程习惯不一样,只能说有个大体的规范
曾经碰到过有人看程序的时候,觉得十六进制数里面A B C D E F小写非常不习惯的

共3条 1/1 1 跳转至

回复

匿名不能发帖!请先 [ 登陆 注册 ]