编程风格总结

编程风格总结

——C/C++编程规范

前言

        优秀的编程风格有利于对代码的阅读理解，优秀的编程风格通常有以下体现：清晰第一，清晰性是易于维护和重构的程序必须具备的特征；简洁为美，简洁就是易于理解且易于实现。

 

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：函数、参数、语句表达式太长时，要进行划分新行。

1-4：不允许把多个短语句写在一行中，一行只写一条语句。

1-5：if、for、do、while、case、switch、default等语句自占一行，而且if、for、do、while等语句的执行语句无论多少都要加括号{}。

     示例：

   if(pUseCR == NULL)

   {

      return;

   }

1-6：对齐只使用空格键，不使用TAB键。

      说明：不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序局部不整齐。

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

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

1-9:一行程序以小于80字符为宜，不要写的过长。

 

2、注释

2-1：一般情况下，源程序有效注释必须在20%以上。

     说明：注释的原本是有助于对程序的阅读、理解，在该加的地方都加了，注释不宜太多也不应太少，注释的语言必须准确、易懂、简洁。

2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版本说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等，头文件的注释中还应该有函数功能简要说明。

    示例：

/**********************************************************

Copyright(C),1988-1999,Huawei Tech. Co.,Ltd.

Filename:                 //文件名

Author:    Version:   Date:   //作者、版本及完成信息

Description:    //用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，                        //输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。

Others:            // 其它内容的说明

Function List://主函数列表，每条记录应包括函数名及功能简要说明

1.  …

2.  …

History:     //修改历史记录列表，每条修改记录应该包括修改日期、修改者及修改内容简                   //述。

1. Ddte:

Author:

Modification:

2. …

***********************************************************

2-4：码边注释，修改代码的同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

2-4：注释的内容要清楚明了，含义准确，防止注释二义性。

     说明：错误的注释不但无益于阅读理解程序，反而对阅读理解程序有害。

2-5：避免在注释中使用缩写，特别是不常用的缩写。

     说明：在使用缩写之前，应该对缩写进行必要的说明。

2-6：注释应该与其描述的代码相近，对代码的注释应该放在其上方或者右方（对单条语句的注释）相邻位置，不可放在下面，如果放在上方应用空行与其上方的代码隔开。

2-7：注释与所描述的内容进行同样的缩排。

     说明：可使程序排版整齐，方便注释阅读。

 

3、标识符命名

3-1：标识符的命名要清晰、明了，有明确的含义，应使用完整的单词或者大家都能理解的缩写，避免使人产生误解。

    示例：如下单词的缩写能够被大家基本认可。

temp 可缩写为 tmp

flag 可缩写为 flg

statistic 可缩写为 stat

increment 可缩写为 inc

message 可缩写为 msg

3-2：命名中若使用特殊约定或缩写，则要有注释说明。

    说明：应在源文件的开始之处对文件中所使用的缩写或约定（特别是特殊的缩写），进行必要的注释说明。另外，自己特有的命名风格要始终保持一致，但是在符合所在项目组或产品组的命名规则下才可使用。

3-3：对于变量命名，禁止取单个字符，建议除了要有具体含义外，还能表明其变量类型、数据类型等，但是i、j、k等单个字符可作局部循环变量。

    说明：变量，尤其是局部变量，如果用单个字符很容易敲错（如i 错敲为 j），而编译的时候又检查不出来，很可能因为这小小的错误而花费大量时间。

4、可读性

4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，尽量避免使用默认优先级。

    说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符导致程序出错。

    示例：下列语句中的表达

word = (high << 8) | low      (1)

if ((a | b) && (a &c))       (2)

if ((a | b) < (c & b)         (3)

如果书写为：

high << 8 | low

a | b && a & c

a | b < c & d

由于

high << 8 | low = (high <<8) | low,

a | b && a & c = (a | b)&& (a & c),

(1)、(2)不会出错，但是语句不易理解；

 a| b < c & d = a | (b < c) & d,（3）造成判断条件出错。

4-2：不要使用难懂的技巧性很高的语句，除非很有必要时。

     说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在与算法。

 

5、变量、结构

5-1：去掉没必要的公共变量。

     说明：公共变量是增大模块间耦合的原因之一，故应该减少没必要的公共变量以降低模块间的耦合度。

5-2：防止局部变量与公共变量同名。

    说明：若使用了较好的命名规则，那么此问题可自动消除。

5-3：严禁使用未经初始化的变量作为右值。

     说明：特别是C/C++中引用未经赋值的指针，经常会引起系统崩溃。

5-4：不要设计面面俱到、非常灵活的数据结构。

     说明：面面俱到、灵活的数据结构反而容易引起误解和操作困难。

 

6、函数、过程

6-1：对所调用函数的错误返回码要仔细、全面的处理。

6-2：明确函数功能，精确（注意！不是近似）地实现函数设计。

6-3：函数的规模尽量限制在200行以内。

6-4：一个函数仅完成一个功能。

6-5：为简单的功能编写函数。

     说明：虽然为仅用一两行就可以完成的功能去编写函数好像没有必要，但是用函数能使功能明确化，增加程序的可读性，也便于维护、测试。

6-6：不要设计多用途、面面俱到的函数。

     说明：多功能集于一身的函数很可能使函数的理解、测试、维护等变得困难。

 

7、程序效率

7-1：变成时要经常注意代码的效率。

     说明：代码的效率分为全局效率、局部效率、时间效率和空间效率。全局效率是站在整个系统的角度上的系统效率；局部效率是站在模块或函数角度的效率；时间效率是程序处理输入任务所需的时间长短；空间效率是程序所需的内存空间，如代码空间大小、数据空间大小、栈空间大小等。

7-2：在保证软件系统的正确性、稳定性及可预测性的前提下提高代码效率。

    说明：不能一味地追求代码效率，而对软件的正确性、稳定性、可读性及可预测造成影响。

7-3：局部效率应为全局效率服务，不能因为提高局部效率而对全面效率造成影响。

 

个人编码模板：

/*文  件  名：三个数求最大值.cpp

  作       者：Key-不会挖洞的猫鼬

  版  本  号：20160403.1.03

  编译环境：Visual Studio 2015

  完成时间：2016.4.3

  主要功能：输入三个整数，输出其中最大整数。

 */

 

//三个数输出最大值

#include<stdio.h> 

 

//宏定义，取a,b中的较大数

#define  max( a ,b ) ( a > b ) ? a : b

 

main()

{

int a , b , c;    //定三个整形变量a,b,c

int big;          //定义整形变量big,用于最大值的输出

printf("请输入3个数\n");

scanf("%d %d %d", &a, & b, & c);

big=max( max ( a , b ), c);

printf("最大数是%d\n",big);

}