zoukankan      html  css  js  c++  java
  • 1排版

    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

    3.       较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

    示例:

    perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
                            + STAT_SIZE_PER_PRAM * 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));

    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  
    }

    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 );

    6.       不允许把多个语句写在一行,即一行只写一条语句。

    示例:以下例子不符合规范。

    rect.length = 0;    rect.width = 0;

    应如下书写:

    rect.length = 0;    
    rect.width = 0;

    7.       if、for、do、while、case、switch、default等语句自占一行,且if、for、do、whie等语句的执行语句部分无论多少都要加括号{}。

    示例:如下例子不符合规范。

    if (pUserCR == NULL) return;

    应如下书写:

    if (pUserCR == NULL)
    {
        return; 
    }

    8.       对齐只使用空格间,不适应TAB键。

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

    9.       在两个以上的关键字、变量、常见进行对等操作时,他们之间的操作符之前、之后或前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后本不应加空格。

    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
    }

    11.       一行程序以小于80字符为宜,不要写的过长。

  • 相关阅读:
    【JAVA基础&Python】静态方法与单例模式,以及应用场景
    【JAVA基础】static的定义
    【JAVA基础&Python】类与对象的继承
    MD的编辑器汇总
    Oracle 学习笔记(二)
    安装Jieba 库出现错误解总结
    (十五)-前端 -项目总结
    (八)-前端-DOM基础
    (十四)-前端-面试-项目相关
    (十三)- 前端-面试-REACT
  • 原文地址:https://www.cnblogs.com/wanghao-boke/p/11672445.html
Copyright © 2011-2022 走看看