小规则让你写出漂亮又高效的程序

标签：

本文来自肥宝游戏，引用必须保留文末二维码！！！ 

文档的结构：

【1】头文件用来声明，cpp文件用来定义。声明和定义分开，不但可以让代码更清晰、方便阅读，同时，如果在某些场合，代码不能公开，只向用户提供头文件和二进制的库即可。通常这样的情况下，头文件和源文件是在不同目录的

【2】为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生预处理块。这个宏定义必须讲究，如果重复了，可能会出现莫名其妙的问题。肥宝个人习惯是工程名+目录+文件名。

例如：

#ifndef _GateApp_Role_Player_H_  
#define _GateApp_Role_Player_H_  
//代码实现在这里。。。  
#endif  

int attack, defense, life; // 攻击、防御、生命，同时声明多个变量，没有初始化
int hurt＝ attack - defense;   life -= hurt； //执行多条语句 
if (life < 0) onDeath();  
for (int i = 0;  i < 10; i++)  findNext();  
processNext();  

良好风格的代码：

int attack = 0; // 攻击 
int defense = 0; // 防御 --跟上下联系紧密，不加空行
int life = 0; // 生命    


 
int hurt＝ attack - defense;   
life -= hurt；


if (0 >= life)    
 {   
    onDeath();   
 }  


for (int i = 0;  i < 10; i++)   
{         
      findNext();      
}                                                     
 
processNext();  

例如 if 、for 、while 等关键字之后应留一个空格再跟（，以突出关键字。  

【13】函数名之后不要留空格，紧跟‘（‘，以与关键字区别。‘（‘向后紧跟，右括号、逗号、分号向前紧跟，紧跟处不留空格。，之后要留空格，如Function(x,  y,  z) 。如果‘; ’不是一行的结束符号，其后要留空格，如 for (int i = 0;  i < 10; i++) 

【14】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符， 如“= ”、“+= ”      “>= ”、“<= ”、“+ ”、“* ”、“% ”、“&& ”、“||”、“<< ”,  “^ ”等二元操作符的前后应当加空格。  

【15】一元操作符如“!”、“~ ”、“++ ”、“-- ”、“& ”（地址运算符）等后不加空格。  

【16】“［］”、“.”、“->”这类操作符前后不加空格。  

【17】对于表达式比较长的 for 语句和 if 语句，为了紧凑起见可以适当地去掉一些空格。

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

这个是C++的风格，java的风格是{紧跟出现前的代码 

【19】 { }之内的代码块在‘{’右边一个制表符处左对齐。 

void Function(int x){  
 // program code  
    }  
 if (condition){  
    }
else{
}

for (initialization; condition; update){  
// program code  
    }


while (condition){  
    }

void Function(int x)                                   
{
     // program code                 
}                                                       

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

for (initialization; condition; update)               
{                                                          
     // program code                                  
}  

While (condition)                                      
{                                                         
    ?// program code                                 
}  

{  
    {  

    }  
}  

【20】代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长，否则要拉来拉去很麻烦

【21】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。表达式内尽量不要套多层表达式。

if ((crit >= 100)
&& (block <= 100)
&& (wreck <= 100))
{
    attack *= 2;
}

virtual CPoint changeToNewPoint(CPoint attackPoint,
                                CPoint defensePoint);

for (SeqCPlayer::iter iter = player.begin();
    iter != player.end();
    iter++)
{
    check();
}

注释

程序块的注释常采用“/*…*/”，行注释一般采用“ //…”。

【22】注释是对代码的“提示”，而不是文档。注释风格统一。

【23】 如果代码本来就是清楚的，则不必加注释。 

【24】边写代码边注释，改代码后要同时修改注释

【25】 注释应当准确、易懂，防止注释有二义性。 错误的注释有害。

【26】 尽量避免在注释中使用缩写，特别是不常用缩写。

【27】 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。在VS中，在上方注释后，下面所有代码的提示都受到影响的，所以优先放后方

【28】 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

【29】 对于思路复杂的代码，可以把思路写在注释里面，否则别人看起来很蛋疼。另外一些设计思想也应该写下来。

对于一些业务多变，而且往往不合常理的需求，一定要多写注释。例如游戏代码中，很多策划特意要求做的特殊处理，有的是为了坑玩家，更多的是为了体验。这东西看代码是看不到任何思路的。当你发现某个地方明明可以用很简洁的代码写，却硬是要用一些很傻比的方法的时候，很可能不是那个人没经验或者偷懒，而是策划要求造成的。所以像游戏这种系统，一定要多谢注释，但改的时候一定要跟着改，否则，呵呵呵呵呵呵呵呵呵呵呵。

类的风格

命名并没有统一的标准！很多公司都有自己的一套标准。

【31】标识符应该可以望文生义，长度尽量小，信息尽量大

【32】 命名规则尽量跟系统风格保持一致

【33】 不要出现紧靠大小写区分的标识

【34】 尽量不要出现标识符完全相同的局部变量和全局变量

【35】 同一个项目的代码下，即使在不同工程内，也不要出现完全相同的文件名称，这是VS的一个bug，调试起来会在同名文件间跳来跳去。

【36】 变量的名字应使用名词或者形容词+名词，函数的名字应该使用动词或者动词+名词

【38】 使用反义词去命名互斥意义的变量或函数

【39】 尽量避免使用数字

下面是肥宝所在的项目的一些规范：

    （1）类名开头大写，结构以S开头，类以C开头，数组用Seq开头，字典类型用Dict开头，指针用Ptr结尾。

    （2）变量和参数用小写开头，之后每个单词开头大写。变量名一般就不加类名这些前缀后缀了。

游戏代码的命名是个蛋疼的事情，作为游戏程序员，碰到的很多名词是无法翻译的。例如诛邪、神兽、涅槃、貔貅、修为、境界、法力，很多很多，有些时候你可能翻译了一个单词出来，过几天一个新的功能，你会发现意义好像差不多的。这个时候我们经常会用拼音，通俗易懂啊。

二、从习惯开始优化程序的性能

表达式和基本语句

【40】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免 使用默认的优先级。

i = a >= b && c < d && c + f <= g + h ; // 复合表达式过于复杂

d = (a = b + c) + r ;

if (a < b < c) // a < b < c 是数学表达式而不是程序表达式
//并不表示 
if (( a < b ) && ( b < c ))
//而成了
if ( (a <b) < c））

bool isPlayer  = ture;
if (flag) // 表示 flag 为真 
if (!flag) // 表示 flag 为假 
//其它的用法都属于不良风格，例如：
if (flag == TRUE) 
if (flag == 1 ) 
if (flag == FALSE) 
if (flag == 0)

int life = 0；
if ( 0 == life) 
if ( 0 != life )
if ( life == 0 )//容易写成 if ( life = 0 ),而且不会报错
//不可模仿布尔变量的风格而写成 
if (value) // 会让人误解 value 是布尔变量 
if (!value)

double x = 0;
if ( 0.0 == x )//隐含错误的比较
if ((x >= -EPSINON) && (x <= EPSINON)) //其中 EPSINON 是允许的误差（即精度）。

//推荐：
if (p == NULL) // p 与 NULL 显式比较，强调 p 是指针变量 i
if (p != NULL) 
//不推荐
if (p == 0) // 容易让人误解 p 是整型变量 
if (p != 0) 
if (p) // 其实肥宝推荐这个，写这么久难道不知道这是指针么。
if (!p)

#include "Test/TestManager.h"
#include "Map/Point.h"
#include <time.h>
#include <iostream>
#include <math.h>


using namespace CppServer;


void doSomething()
{
    SPoint p;
    p.x = 1;
    p.y = 1;
    int dist = p.x * p.x + p.y * p.y;
    dist += p.x;
    dist += p.y;
    dist = (int)sqrt(dist);
    SPoint p2;
}
void CppServer::CTestManager::test1()
{
    int n = 100;
    for (int m = 100; m <= 100000; m += 1000) {
        {
            clock_t startTime = clock();//开始时间
            for (int i = 0; i <= m; i++) {
                for (int j = 0; j <= n; j++) {
                    doSomething();
                }
            }

            clock_t endTime = clock();//结束时间
            std::cout << "多重循环1 i ：" << m <<" j:"<<n << " time:" << (endTime - startTime) << std::endl;
        }

        {
            clock_t startTime = clock();//开始时间
            for (int i = 0; i <= n; i++) {
                for (int j = 0; j <= m; j++) {
                    doSomething();
                }
            }

            clock_t endTime = clock();//结束时间
            std::cout << "多重循环2 i ：" << n << " j:" << m << " time:" << (endTime - startTime) << std::endl << std::endl;
        }
    }
}

【49】不可在 for 循环体内修改循环变量，防止 for 循环失去控制。尤其注意erase的用法

我们游戏服务端宕机有一半是这个引起的，每次新人来了都跟他们说，说了还是会犯错。

typedef std::vector<CPoint> SeqCPoint;
typedef std::map<int, CPoint> MapCPoint;
SeqCPoint points;
MapCPoint pointMap;
for (SeqCPoint::iter iter = points.begin();
    iter != points.end();
    )
{
    if(xxx)
    {
        points.erase(iter);//erase后，指针会跳到下一个
    }
    else
    {
        iter ++;
    }
}


for (MapCPoint::iter iter = pointMap.begin();
    iter != pointMap.end();
    iter ++;)
{
    if(xxx)
    {
        pointMap.erase(iter);//erase不需要特殊处理
    } 
}

【51】 少用慎用goto。

肥宝觉得，业务层的代码，直接禁用吧！

const float PI = 3.14159; // C++ 语言的 const 常量

【53】 需要对外公开的常量放在头文件，内部使用的放在源文件。

很多人喜欢把常量放在同一个文件中，但是多了之后改动一下，多个地方要编译。我们游戏曾经加一个错误码要编两个小时，后面改成配置了，这个自己把握吧。

SPoint CMapManager::changeAbsolute2Relative(SPoint& originPoint, SPoint& changePoint)  
{  
    SPoint rePoint;  
    rePoint.x = changePoint.x - originPoint.x;  
    rePoint.y = changePoint.y - originPoint.y;  
    return rePoint;  
}  

bool checkCanAttack( int life,   int distance = 0 )  
{  
    if ( life > 0  )
    {
        return false;
    }
    doOther();
    return true;
}  
checkCanAttack(100, 100);

bool checkCanAttack( int life, bool isFighting = false, int distance = 0, int maxDistance = 0)  
{  
    if ( life > 0 && !isFighting)
    {
        return false;
    }
    return true;
}  
checkCanAttack(100,   100);//原来的使用并没有因为函数参数改了而出错，如果大量使用到，很容易出错而且无法调试

因为调用地方太多，有的地方改漏了，在外网正式服出现了问题被人投诉才知道。

后来肥宝的解决办法是把默认参数都去掉，然后一个个找错，是在没办法了。

bool isWeekDay( int day )//判断是否是周末
{
    if( day == 6 || day == 0)
    {
        return false;//应该返回true，但是却返回false
    }
    return true;
}

//效率高，直接在函数外部构造了
return String(s1 + s2); 
//效率低，需要经过构造，传递，析构
String temp(s1 + s2);
return temp;
当然，这个对基础类型没什么作用
return 1 + 1;
int temp = 1 + 1;
return temp;

    struct SPoint
    {
        void init();
        int x;
        int y;
        int z[100000];
    };


    void SPoint::init()
    {
        x = 0;
        y = 0;
    }


    int count = 10000000;
    {
        CppServer::SPoint p;
        clock_t startTime = clock();//开始时间
        for (int i = 0; i <= count; i++) {
            //p.init();
            p.x = 1;
            p.y = 1;
            int distance = sqrt(p.x * p.x + p.y * p.y);
        }
        clock_t endTime = clock();//结束时间
        std::cout << "time:" << (endTime - startTime) << std::endl;
    }
    {


        clock_t startTime = clock();//开始时间
        for (int i = 0; i <= count; i++) {
            CppServer::SPoint p;
            p.x = 1;
            p.y = 1;
            int distance = sqrt(p.x * p.x + p.y * p.y);
        }
        clock_t endTime = clock();//结束时间
        std::cout << "time:" << (endTime - startTime) << std::endl;
    }

结果效率一样，但是如果执行了上面被注释的init函数后，时间消耗大大提高。初始化可能更加占消耗

【70】内联函数是用于实现的，声明的时候不用写。在头文件实现的函数自动成为内联函数

构造函数、析构函数、赋值函数

其他的建议

【82】优化程序的时候，要充分考虑游系统的特性，找出瓶颈所在。例如一个MMO游戏，在初期推广的时候，很多新玩家，经常在某个时段某个功能很多人同时玩，这个要注意。到了后期的功能，可能会很少人接触，但是在后来往往有很多跨服功能，几乎所有玩家在同一个服玩，这些都是要考虑的问题。

【84】先优化数据结构，再优化算法

【86】避免编写技巧性很高代码。

【87】当心变量发生上溢或下溢,数组的下标越界。

【89】尽量不要使用与具体硬件或软件环境关系密切的变量。

最后：

小规则让你写出漂亮又高效的程序

标签：

原文地址：http://blog.csdn.net/u012175089/article/details/51078360