开发规范V1.0

《开发规范V1.0》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、讯奇/巨力开发规范讯奇/巨力开发规范版本:1.0日期:<2010-05-07>广州讯奇数码科技有限公司/汕头市巨力科技有限公司版权所有不得翻印广州讯奇数码科技有限公司/汕头市巨力科技有限公司Allrightsreserved讯奇/巨力开发规范目录修改历史31C++开发规范41.1文件夹命名：41.2文件命名：41.3类命名：41.4结构体命名：51.5枚举命名：51.6宏命名：51.7全局函数：51.8静态函数：61.9指针、全局变量、局部静态变量：61.10函数设计：61.11类设计：71.12源代码文件设计：71.13日志规范82Java开发规范92.1

2、严格遵守Java本身的风格92.2流水日志92.3性能日志92.4包设计92.5类设计102.6类属性设计102.7类方法设计102.8源代码文件设计102.9关于废代码问题10广州讯奇数码科技有限公司/汕头市巨力科技有限公司Allrightsreserved讯奇/巨力开发规范修改历史时间内容作者2009-1-22创建本文档梁兵l广州讯奇数码科技有限公司/汕头市巨力科技有限公司Allrightsreserved讯奇/巨力开发规范1C++开发规范1.1文件夹命名：采用全小写，多个单词之间直接连接。由于文件夹数量相对比较少，我们使用一两个单词就可以表达清楚，所以

3、这种命名方式足够了。名称一般要体现名词性。例如：framework、webwatch、yahoohttp、chat163、msnudpfile1.2文件命名：采用每个单词首字母大写，单词其余部分全小写，多个单词之间直接连接；只有一个单词，首字母也要大写。名称一般要体现名词性。例如：Chat.h、Chat.cpp、CommandParser.h、CommandParser.cpp、DBQueryPool.h、DBQueryPool.cpp、TcpSessionList.h、TcpSessionList.cpp1.3类命名：类名：采用每个单词首字母大写，单词其余

4、部分全小写，多个单词之间直接连接；只有一个单词，首字母也要大写。（与文件名命名相同）名称一般要体现名词性。例如：classChat{…}；classLineReader{…}；classCommandParser{…}；classDBQueryPool{…}；成员函数名：采用单词首字母大写，多个单词之间直接连接；只有一个单词，首字母也要大写。名称一般要体现动词性，单个动词或动宾结构。例如：classLineReader{public:intPush(void*buf,intsize);intGetLine(void*buf,intsize);intGetLi

5、neLen();private:voidMoveData(intcopyLen);private:int_count;int_bufIndex;int_bufSize;char*_pBuf;}；成员变量名：以下划杠开头,之后部分和成员函数名命名方式一样。广州讯奇数码科技有限公司/汕头市巨力科技有限公司Allrightsreserved讯奇/巨力开发规范例子参见上面代码片段。名称一般要体现名词性。1.1结构体命名：与1.3类名命名相同。名称一般要体现名词性。例如：typedefstructDataTrunk{unsignedint_type;char_data

6、[256];void*_pData;structDataTrunk*_pNext;}DataTrunk；1.2枚举命名：枚举名：与1.3类名命名相同。成员名：所有字母大写，各单词之间用下划杠分隔。名称一般要体现名词性。例如：enumDataTrunkType{ETHER_PKG=0,IP_PKG=1,UDP_PKG=2,TCP_PKG=3,MSG_STARTUP=4,MSG_SHUTDOWN=5,MSG_LOAD=6,MSG_UNLOAD=7,TCP_STREAM=8};1.3宏命名：所有字母大写，各单词之间用下划杠分隔。名称一般要体现名词性。例如：#def

7、ineIPCHAIN_SIZE64#definePACKDIR_OUT0#definePACKDIR_IN1#definePACKDIR_OTHER21.4全局函数：所有字母小写，各单词之间用下划杠分隔。名称一般要体现动宾结构。例如：intinit_db_pool();voidparse_mail(char*data,string&from);广州讯奇数码科技有限公司/汕头市巨力科技有限公司Allrightsreserved讯奇/巨力开发规范1.1静态函数：所有字母小写，各单词之间用下划杠分隔。名称一般要体现动宾结构。记住需要添加static关键字。例如：s

8、taticvoidprocess_db_pool()