================================================================================
标题: C 模拟类的命名规范
作者: 叶飞虎
日期: 2017.01.04
注:
在条款细节之前, 先说明一下命名规范的整体原则:
原则 含义
同一性 在编写一个子模块或模拟类的时候, 要遵循其模拟类或整体模块
的命名风格, 保持命名风格在整个模块中的同一性。
驼峰式名称 名称为一个或多个单词组成, 为了便于界定, 每个单词的首字
母要大写。
标识符组成 标识符采用英文单词或其组合, 应当直观且可以拼读, 可望文
知意, 用词应当准确, 使用驼峰式名称。
最小长度最大信息量 在保持一个标识符意思明确的同时, 应当尽量缩短其长度。
避免过于相似 不要出现仅靠大小写区分的相似的标识符, 例如: "i"与"I",
"function"与"Function"等等。
避免重名 程序中不要出现名字完全相同的局部变量和全局变量, 尽管两
者的作用域不同而不会发生语法错误, 但容易使人误解。
正确命名互斥标识符 用正确的反义词组命名具有互斥意义的标识符, 如:
"nMinValue"和"nMaxValue", "GetName()"和"SetName()" ...
避免名字中数字编号 尽量避免名字中出现数字编号, 如Value1,Value2等, 除非逻辑
上的确需要编号。这是为了防止程序员偷懒, 不肯为命名动脑
筋而导致产生无意义的名字(因为用数字编号最省事)。
-
版面格式
a. 空行的使用
空行起着分隔程序段落的作用, 空行得体(不过多也不过少)将使程序的布局更加清晰。在一个函数体内, 逻揖上密切相关的语句之间不加空行, 其它地方应加空行分隔。b. 语句与代码行
1). 一行代码只做一件事情, 如只定义一个变量或只写一条语句, 这样的代码容易阅读, 并且方便于写注释;
2). if, for, while, do 等语句自占一行, 执行语句不得紧跟其后;
3). {} 在单行语句时必须省略, 这样看起来要简洁。c. 缩进和对齐
1). 代码缩进必须使用空格保存, 缩进空格数[2…4]必须整个文件统一;
2). 程序的分界符 ‘{’ 和 ‘}’ 应独占一行并且位于同一列，同时与引用它们的语句左对齐;
3). {…} 之内的代码块在 ‘{’ 右边一个缩进处左对齐, 如果出现嵌套的 {…}, 则使用缩进对齐, 缩进必须使用空格, 且空格数在整个工程中必须统一。d. 最大长度和行数
1). 代码行最大长度宜控制在 100 个字符以内, 代码行不要过长，否则眼睛看不过来, 也不便于打印;
2). 一个函数或方法的代码行数尽量控制在 100 行以内, 代码行数太多会令人抓狂!e. 长行拆分
长表达式要在低优先级操作符处拆分成新行, 操作符放在新行之首(以便突出操作符), 拆分出的新行要进行适当的缩进, 使排版整齐, 语句可读。f. 空格的使用
1). 关键字之后要留空格
如 const, inline, case 等关键字之后至少要留一个空格, 否则无法辨析关键字, 如 if, for, while 等关键字之后应留一个空格再跟左括号 ‘(’ 以突出关键字;
2). 函数名之后不要留空格，紧跟左括号 ‘(’ 以与关键字区别;
3). ‘(’ 向后紧跟, 而 ‘)’ ‘,’ ‘;’ 向前紧跟, 紧跟处不留空格;
4). ‘,’ 之后要留空格, 如: SetPoint(x, y);
5). ‘;’ 若不是一行的结束符则其后要留空格，如: for (i = 0; i < 10; i++);
6). 赋值操作符, 比较操作符, 算术操作符, 逻辑操作符, 位域操作符等二元操作符的前后应当加空格, 如: intCount += 10;
7). 一元操作符前后不加空格, 如: “!”, “~”, “++”, “–”, “&”(地址运算符)
8). “[]”, “.”, “->” 这类操作符前后不加空格。g. 修饰符的位置
为便于理解, 应当将修饰符 '’ 紧靠数据类型, 如: long pValue。h. 注释
1). 注释的位置应与被描述的代码相邻, 可以放在代码上方或右方, 不可放在下方;
2). 边写代码边注释, 修改代码同时修改相应的注释, 以保证注释与代码的一致性, 不再有用的注释要删除;
3). 注释应当准确易懂, 防止注释有二义性, 错误的注释不但无益反而有害;
4). 当代码比较长, 特别是有多重嵌套时, 应当在一些段落的开头加注释。 -
命名规则
a. 文件宏命名最好与文件名相同, 格式: ‘_’ + + “H”。b. 模拟类命名
1). 模拟类以大写字母 ‘T’ 开头的后跟驼峰式名称;
2). 模拟类为类数据的指针, 类数据名称为: <类名> + “Data”;
公开数据成员必须放在前面, 私有数据成员是受保护的, 只表示私有数据在类数
据中占据的内存空间尺寸。
// 定义 TClassDemo 对象数据
typedef struct
{
// ------ 公开数据成员 ------
void* Tag; // 自定义数据// ------ 私有数据成员 ------ void* Data[4]; // 注: 对象占用数据不能修改 char ExtData[SizeOf_Txxx1 + SizeOf_Txxx2]; } TClassDemoData; // 定义 TClassDemo 对象类型 typedef TClassDemoData* TClassDemo; // TClassDemo 类数据尺寸 #define SizeOf_TClassDemo sizeof(TClassDemoData)3). 模拟类尺寸必须定义为类数据结构尺寸;
4). 模拟类的私有数据成员不公开, 必须使用 void* 指针数组来表示占用尺寸;
5). 若含有其它类数据时,必须放在扩展数据 ExtData 中使用类尺寸表示出来;
6). 模拟类的构造函数和析构函数必须提供两组函数:
a). Init 和 Fini 函数用于构造和析构已存在内存空间的对象数据;
// 初始化/释放 TClassDemo 对象数据
// 1. TClassDemo_Init 返回的对象就是 AData 指针, 且对象必须使用
// TClassDemo_Fini 来释放数据;
// 2. 本组函数适用于不分配对象指针情况, 如不分配对象指针的函数局部变量或结构中.
TClassDemo TClassDemo_Init(TClassDemoData* AData);
void TClassDemo_Fini(TClassDemoData* AData);b). Create 和 Free 函数用于创建和释放对象的内存空间。 // 创建/释放 TClassDemo 对象(注: 当 object == NULL 时, TClassDemo_Free 不会产生异常) TClassDemo TClassDemo_Create(void); void TClassDemo_Free(TClassDemo object);7). 模拟类的方法定义格式如下:
a). 方法名定义: <类名> + ‘_’ + <方法名>;
b). 方法的第一个参数为: <类名> object, 为了效率不检查 object 是否合法,
此参数需要外部来维护, 示例:
// 注: 为了效率不检查 TClassDemo object 是否合法, 此参数需要外部来维护.
int TClassDemo_SetName(TClassDemo object, const char* AName);8). 模拟类的属性方法分为: 读取属性和设置属性
a). 读取属性方法定义: <类名> + ‘_’ + <属性名>
b). 设置属性方法定义: <类名> + “_Set” + <属性名>9). 以上为在 “.h” 头文件中的格式定义, 而类实际存放项定义放在 “.c” 代码文件中:
a). 实际存放项名称定义: ‘_’ + <类名>;
b). 公开数据成员必须与 “.h” 头文件中类数据定义一致, 且放在前面;
c). 私有数据成员为实际成员项, 若需要透传给外部调用, 则必须紧跟公开数据成员后面, 否则私有数据成员相互位置无关。
// TClassDemo 类型
typedef struct
{
// ------ 公开数据成员 ------
void* Tag; // 自定义数据// ------ 保护数据成员 ------ void* Owner; // 所有者, 外部可以通过 Data[0] // 来存取项, 属于受保护约定! // ------ 私有数据成员 ------ Txxx1Data xxx1; // Txxx1 对象数据 Txxx2Data xxx2; // Txxx2 对象数据 char* Name; // 名称 int Type; // 类型 int Size; // 尺寸 } _TClassDemo, *_PClassDemo;10). 模拟类的私有方法定义格式如下:
a). 静态函数为私有方法;
b). 若 “.c” 代码只有有一个类则方法名定义: “L_” + <方法名>;
c). 若 “.c” 代码有多个类则方法名定义: “L_” + <简略名> + ‘_’ + <方法名>;
d). 私有方法的第一个参数为: <类实际结构指针> _this, 示例如下:
// 执行打开
static int L_DoOpen(_TClassDemo* _this, const char* AName)
{
… …
}// 打开 int TClassDemo_Open(TClassDemo object, const char* AName) { _TClassDemo* _this = (_TClassDemo*)object; ... ... result = L_DoOpen(_this, AName); ... ... }c. 结构命名
1). 结构以大写字母 ‘T’ 开头的后跟驼峰式名称: “T” + <结构名>;
2). 为了区别结构指针与模拟类, 结构指针以 ‘P’ 开头: “P” + <结构名>;
3). 若结构项中必须使用结构本身, 则在 struct 后名称: ‘_’ + <结构名> + “_t”;
4). 结构定义形式如下:
// 定义 TNode 结构
typedef struct _Node_t // _Node_t 只有结构项中用到才定义, 否则不必定义!
{
void* Data;
struct _Node_t* Next;
} TNode, *PNode; // PNode 为结构项指针类型
================================================================================
扫一扫
2670
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
