My软件编写规范

My软件编写规范

0）  所有的函数名称、变量名称、类名称命名均采用英语，不得采用汉语拼音或者拼音的缩写。英文缩写除几个常用缩写外，一般不采用缩写。

 

1）  在该函数模块主要面向计算机实现的情况： 而其包含的语义抽象层次较低的时候，变量命名采用弱的匈牙利命名法。

一般变量采用“变量类型前缀+英文单词+英文单词"的命名方法。其中每个英文字母大写，而变量前缀小写。比如strResultName。

循环变量一般采取nIndex这种命名，禁止采用i，j，k这种单个字母作为循环变量。

 

2）  函数模块主要面向较高层次的抽象语义的情况：变量采用其含义命名。所有字母均为小写，两个单词之间用下划线连接。

比如result_name_string. 禁止两个单词连在一起而不用下划线分开。这种命名方法称为“语义命名法”。

 

3）  所有类和结构的名称命名规范：所有的自己写的类名称，用下划线开头，中间的单词用下划线连接。

比如 class _sms_body{}; 其变量命名一般如： _sms_body sms_body; 或者如: _sms_body temp_sms_body;

 

4）  函数命名规范：所有函数的名称首字母大写，后面每个单词的首字母均大写。

当函数名称过长的时候，在适当的单词连接处用下划线连接。比如GetTheHeader( );

 

5）  类成员变量（静态成员变量除外）一概用小写的"m_"开头，如果是指针类型则是"m_p"开头。

成员变量视其抽象程度，如果抽象程度低，在前缀后采用弱匈牙利命名方法；如果抽象程度高，采取“语义命名法”。

 

6）  函数名称可以加前缀单词或者后缀单词，表明其是否是临时函数或者仅供测试的函数、或者标明其版本号码或者修改时间。