程序编码规范.docx

蜗牛游戏程序编码规范（）
规范说明：1
一、 命名规则1
二、 程序的版式3
三、 注释5
四、 服务端平台无关7
五、 服务端表格操作7
六、 客户端文件读写8
七、 客户端内存操作8
八、 脚本内的注释9
规范说明：
制定该规范的U的是让程序清晰易懂、易维护、易管理。该规范为强制规范，必须执 行，如果有没涉及的地方请参考《高质量C++-C编程指南》。当所在编程环境（如 MFC、Linux）与本规范有差异时，可以使用所在编程环境的规范，但是同一个工程 必须是统一的规范。
最后希望大家都能养成一个良好的程序习惯，一个好的习惯受益终身！
命名规则
所有命名应肖直观且可拼读，并具有实际意义；
2•类名和函数名用大写字母开头的单词组合而成，接口类名以I开头；
3・常量全用大写的字母，用下划线分割单词，尽量不要使用宏；
」静态变量加前缀s」
5-变量名第一个字母小写，使用“名词”或“形容词+名词”的词义表示法;
示例：
・局部变量
char*pStringBuffer；
int&stringFindResult；
bool isEngineStartup：
•函数命名
unsigned intGetVoyageCoreState()。
static boolGetVoyageServiceCount(int &count)o
•结构类型
struct NodeValue
{
intwidtho
intheighto
}
•枚举类型(枚举值必须大写且有前缀) enum VoyageSupportType
{
VOYAGE OS SUPPORT INVALID二 1, VOYAGE_OS_SUPPORTJVINDOWS二 2
}
•联合类型
unionColor
{
unsigned char arrColor[3]o
struct ColorRGB
{
unsigned char r。
unsigned char go
unsigned char b。
}。
}o
•类类型
class Object
int m_widtho
〃宽度
voidSetValue (int width, int height) o // 成员函数
virtual int GetArea() □ // 虚函数 inline intGetWidth() o // 内联函数
};
•抽象类
class ISpriteManager
{
public：
virtual int GetSpriteID() = 0。
virtual bool IsSpriteExist()= 0。
}o
・自定义类型
typedefunsigned intNumbero
・全局变量(我们不主张使用全局变量)
int g_howManyPe op1e。
•静态变量
static char*s_pStringBuffero
•常量
constfloat = 100. Of。
・回调函数
typedef int(*CALLBACK_SYSTEMINIT_FUNC)(IKernel * pK