zoukankan      html  css  js  c++  java
  • 良好的编程习惯

    http://sawfish.blogchina.com/
    http://www.osprg.org/modules/wfsection/article.php?articleid=8,感谢

    // 版权和版本声明见示例1-1,此处省略。

    #ifndef GRAPHICS_H // 防止graphics.h被重复引用
    #define GRAPHICS_H

    #include <math.h> // 引用标准库的头文件
    ...
    #include "myheader.h" // 引用非标准库的头文件
    ...
    void Function1(...); // 全局函数声明
    ...
    class Box // 类结构声明
    {
    ...
    };
    #endif
    示例1-2 C++/C头文件的结构


    1.3 定义文件的结构

    定义文件有三部分内容:

    (1) 定义文件开头处的版权和版本声明(参见示例1-1)。
    (2) 对一些头文件的引用。
    (3) 程序的实现体(包括数据和代码)。

    假设定义文件的名称为 graphics.cpp,定义文件的结构参见示例1-3。

    // 版权和版本声明见示例1-1,此处省略。

    #include "graphics.h" // 引用头文件

    ...

    // 全局函数的实现体

    void Function1(...)
    {
    ...
    }

    // 类成员函数的实现体
    void Box::Draw(...)
    {
    ...
    }

    示例1-3 C++/C定义文件的结构
    1.4 头文件的作用

    早期的编程语言如Basic、Fortran没有头文件的概念,C++/C语言的初学者虽然会用使用头文件,但常常不明其理。这里对头文件的作用略作解释:

    (1)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。

    (2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。
    1.5 目录结构

    如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。

    例如可将头文件保存于include目录,将定义文件保存于source目录(可以是多级目录)。

    如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其"声明"。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。
    第2章 程序的版式

    版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。

    可以把程序的版式比喻为"书法"。好的"书法"可让人对程序一目了然,看得兴致勃勃。差的程序"书法"如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的"书法",弥补大学计算机教育的漏洞,实在很有必要。
    2.1 空行

    空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。

    l 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1(a)

    l 【规则2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。参见示例2-1(b )

    // 空行

    void Function1(...)

    {

    ...

    }

    // 空行

    void Function2(...)

    {

    ...

    }

    // 空行

    void Function3(...)

    {

    ...

    }


    // 空行

    while (condition)

    {

    statement1;

    // 空行

    if (condition)

    {

    statement2;

    }

    else

    {

    statement3;

    }

    // 空行

    statement4;

    }

    示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行


    2.2 代码行

    l 【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。

    l 【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

    示例2-2(a)为风格良好的代码行,示例2-2(b)为风格不良的代码行。

    int width; // 宽度

    int height; // 高度

    int depth; // 深度


    int width, height, depth; // 宽度高度深度

    x = a + b;

    y = c + d;

    z = e + f;


    X = a + b; y = c + d; z = e + f;

    if (width < height)

    {

    dosomething();

    }


    if (width < height) dosomething();

    for (initialization; condition; update)

    {

    dosomething();

    }

    // 空行

    other();


    for (initialization; condition; update)

    dosomething();

    other();

    示例2-2(a) 风格良好的代码行 示例2-2(b) 风格不良的代码行

    ² 【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)

    如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。例如

    int width = 10; // 定义并初绐化width

    int height = 10; // 定义并初绐化height

    int depth = 10; // 定义并初绐化depth


    2.3 代码行内的空格

    l 【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(',以突出关键字。

    l 【规则2-3-2】函数名之后不要留空格,紧跟左括号‘(',以与关键字区别。

    l 【规则2-3-3】‘('向后紧跟,‘)'、‘,'、‘;'向前紧跟,紧跟处不留空格。

    l 【规则2-3-4】‘,'之后要留空格,如Function(x, y, z)。如果‘;'不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。

    l 【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如"="、"+=" ">="、"<="、"+"、"*"、"%"、"&&"、"||"、"<<","^"等二元操作符的前后应当加空格。

    l 【规则2-3-6】一元操作符如"!"、"~"、"++"、"--"、"&"(地址运算符)等前后不加空格。

    l 【规则2-3-7】象"[]"、"."、"->"这类操作符前后不加空格。

    ² 【建议2-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))

    void Func1(int x, int y, int z); // 良好的风格

    void Func1 (int x,int y,int z); // 不良的风格

    if (year >= 2000) // 良好的风格

    if(year>=2000) // 不良的风格

    if ((a>=b) && (c<=d)) // 良好的风格

    if(a>=b&&c<=d) // 不良的风格

    for (i=0; i<10; i++) // 良好的风格

    for(i=0;i<10;i++) // 不良的风格

    for (i = 0; I < 10; i ++) // 过多的空格

    x = a < b ? a : b; // 良好的风格

    x=a<b?a:b; // 不好的风格

    int *x = &y; // 良好的风格

    int * x = & y; // 不良的风格

    array[5] = 0; // 不要写成 array [ 5 ] = 0;

    a.Function(); // 不要写成 a . Function();

    b->Function(); // 不要写成 b -> Function();

    示例2-3 代码行内的空格

    2.4 对齐

    l 【规则2-4-1】程序的分界符‘{'和‘}'应独占一行并且位于同一列,同时与引用它们的语句左对齐。

    l 【规则2-4-2】{ }之内的代码块在‘{'右边数格处左对齐。

    示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。

    void Function(int x)

    {

    ... // program code

    }


    void Function(int x){

    ... // program code
    }

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

    if (condition){
    ... // program code
    }
    else {
    ... // program code
    }
    for (initialization; condition; update)
    {
    ... // program code
    }
    for (initialization; condition; update){
    ... // program code
    }
    While (condition)
    {
    ... // program code
    }
    while (condition){
    ... // program code
    }
    如果出现嵌套的{},则使用缩进对齐,如:

    {
    ...
    {
    ...
    }
    ...
    }

    示例2-4(a) 风格良好的对齐 示例2-4(b) 风格不良的对齐


    2.5 长行拆分

    l 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
    l 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

    if ((very_longer_variable1 >= very_longer_variable12)
    && (very_longer_variable3 <= very_longer_variable14)
    && (very_longer_variable5 <= very_longer_variable16))
    {
    dosomething();
    }
    virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,

    CMatrix rightMatrix);

    for (very_longer_initialization;
    very_longer_condition;
    very_longer_update)
    {
    dosomething();
    }

    第3章 命名规则


    比较著名的命名规则当推Microsoft公司的"匈牙利"法,该命名规则的主要思想是"在变量和函数名中加入前缀以增进人们对程序的理解"。例如所有的字符变量均以ch为前缀,若是指针变量则追加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指针。

    "匈牙利"法最大的缺点是烦琐,例如

    int i, j, k;

    float x, y, z;

    倘若采用"匈牙利"命名规则,则应当写成

    int iI, iJ, ik; // 前缀 i表示int类型

    float fX, fY, fZ; // 前缀 f表示float类型

    如此烦琐的程序会让绝大多数程序员无法忍受。

    据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是"成败悠关"的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。
    3.1 共性规则

    本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则,如3.2节。

    l 【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行"解码"。

    标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。

    l 【规则3-1-2】标识符的长度应当符合"min-length && max-information"原则。

    几十年前老ANSI C规定名字不准超过6个字符,现今的C++/C不再有此限制。一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好?不见得! 例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

    l 【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

    例如Windows应用程序的标识符通常采用"大小写"混排的方式,如AddChild。而Unix应用程序的标识符通常采用"小写加下划线"的方式,如add_child。别把这两类风格混在一起用。

    l 【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。

    例如:

    int x, X; // 变量x 与 X 容易混淆

    void foo(int x); // 函数foo 与FOO容易混淆

    void FOO(float x);

    l 【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。

    l 【规则3-1-6】变量的名字应当使用"名词"或者"形容词+名词"。

    例如:

    float value;

    float oldValue;

    float newValue;

    l 【规则3-1-7】全局函数的名字应当使用"动词"或者"动词+名词"(动宾词组)。类的成员函数应当只使用"动词",被省略掉的名词就是对象本身。

    例如:

    DrawBox(); // 全局函数

    box->Draw(); // 类的成员函数

    l 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

    例如:

    int minValue;

    int maxValue;

    int SetValue(...);

    int GetValue(...);

    2 【建议3-1-1】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。
    3.2 简单的Windows应用程序命名规则

    作者对"匈牙利"命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用软件的开发。

    l 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。

    例如:

    class Node; // 类名

    class LeafNode; // 类名

    void Draw(void); // 函数名

    void SetValue(int value); // 函数名

    l 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。

    例如:

    BOOL flag;

    int drawMode;

    l 【规则3-2-3】常量全用大写的字母,用下划线分割单词。

    例如:

    const int MAX = 100;

    const int MAX_LENGTH = 100;

    l 【规则3-2-4】静态变量加前缀s_(表示static)。

    例如:

    void Init(...)

    {

    static int s_initValue; // 静态变量

    ...

    }

    l 【规则3-2-5】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

    例如:

    int g_howManyPeople; // 全局变量

    int g_howMuchMoney; // 全局变量

    l 【规则3-2-6】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

    例如:

    void Object::SetValue(int width, int height)

    {

    m_width = width;

    m_height = height;

    }

    l 【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。
    3.3 简单的Unix应用程序命名规则

    http://www.chinaunix.net/bbsjh/16/54.html
    浙大林锐博士的《软件工程思想》一书中的全部8个篇章。这是林锐在自己经营公司不够成功后的深刻总结,值得推荐,他的另一篇文章《大学十年》也很不错。

  • 相关阅读:
    170120、java 如何在pdf中生成表格
    170119、100亿数据1万属性数据架构设计
    170118、快速失败Vs安全失败(Java迭代器附示例)
    170117、spring解决乱码
    170116、centos6.4下nginx和ftp搭建图片服务器
    170113、CentOs6.4中安装和配置vsftp简明教程
    linux nginx完全卸载
    DevOps 的技术栈与工具链
    git与pycharm结合使用
    JMeter和JMeterPlugin的下载安装
  • 原文地址:https://www.cnblogs.com/bobomail/p/409929.html
Copyright © 2011-2022 走看看