C 编程规范（变量，结构体，typedef，函数，枚举，宏的命名）_类的成员变量必须以下划线结尾吗

1、命名约定

1.1 通用 命名规则

函数命名，变量命名，文件命名要有描述性，少用缩写。
注意，一些特定的广为人知的缩写是允许的，例如用i表示迭代变量(iteration)和用T表示模板参数(template)。

目前主要有 4种命名风格：

1.2 文件名 命名规则

文件名要全部小写，可以包含下划线 _或连字符 -,，依照项目的约定。如果没有约定。那么下划线 _更好。
例如：my_useful_class.c

1.3 变量 命名规则

变量（包括函数参数） 和数据成员名一律小写，单词之间用下划线 _连接。
类的成员变量以下划线结尾，但结构体的就不用。

1.4 类型 命名规则

所有类型命名：类，结构体，类型定义（typedef），枚举，类型模板参数，均使用相同约定，即以大写字母开始，每个单词首字母均大写，不包含下划线（帕斯卡命名法）。例如：

class BookCartoon {
	string 	title_;		
	string 	author_;		
};

struct BookCartoon {
	char 	title[40];		
	char 	author[40];		
};

typedef struct {
	char 	title[40];		
	char 	author[40];				
} BookCartoon;

enum ButtonState {
	SHORT_PRESS,	/* 短按 */
	LONG_PRESS,		/* 长按 */
};

typedef enum  {
	SHORT_PRESS,	/* 短按 */
	LONG_PRESS,		/* 长按 */
} ButtonState;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

类型 变量 采用驼峰命名：

1.5 函数 命名规则

一般来说，函数名的每个单词首字母大写，没有下划线。
对于首字母缩写的单词，更倾向于将它们视作一个单词进行首字母大写。

1.6 枚举 命名规则

枚举的命名应当和常量或宏一致：kEnumName或是ENUM_NAME。

typedef enum  {
	BS_SHORT_PRESS,	/* 短按 */
	BS_LONG_PRESS,	/* 长按 */
} ButtonState;
1
2
3
4

1.7 宏 的命名规则

命名全部大写，使用下划线 _连接。

 #define 	SECONDS_PER_YEAR 	(60 * 60 * 24 * 365)UL
1

2、函数

3、质量保证

4、程序效率

在保证软件系统的 正确性、简洁、可维护性、可靠性 及 可测性的前提下，提高代码效率。

5、注释

优秀的代码 不写注释也可轻易读懂，注释无法把糟糕的代码变好，需要很多注释来解释的代码往往存在坏味道，需要重构。

命名的 常用缩写