软件编程规范!!大家学下!!我也是初学者,学C语言3个月!~~
标识符命名(14条规则+1条建议)共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则。
命名两个基本原则:
1.含义清晰,不易混淆;
2.不与其它模块、函数的命名空间相冲突。
【规则3-1-1】标识符要清楚、准确、简单而且尽量可发音的英文名字。
例如:int returnStatus;
不要把currentValue 写成nowValue 。
【规则3-1-2】标识符的长度应当符合“min-length && max-information”(最短并包含信息最多)原则。单字符的名字也是有用的,常见的如i、j、k、m、n、x、y、z 等,它们通常可用作函数内的局部变量。
【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。
例如Windows应用程序的标识符通常采用“大小写”混排的方式,如printStudent;而Unix 应用程序的标识符通常采用“小写加下划线”的方式,如print_student。别把这两类风 格混在一起用。
【规则3-1-4】尽量选择通用词汇并保持整个软件风格一致。
例如:使用get、read、fetch 、retrieve都能表达“取出”的意思,一旦软件采用哪一 个则应贯穿始终。
【规则3-1-5】程序中不要出现仅靠大小写区分的相似的标识符。
例如:int x, X; /* 变量x 与X 容易混淆*/
void foo(int y); /* 函数foo 与FOO 容易混淆*/
void FOO(float y);
【规则3-1-6】程序中不要出现标识符完全相同的局部变量和全局变量,尽管可能两者的作用域不同而不会发生语法错误,但会使人误解。
【规则3-1-7】变量的名字应当使用“名词”或者“形容词+名词”。
例如: float value;
float newValue;
【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
例如: int MinValue;
int MaxValue;
int MinValue(void);
int MaxValue(void);
【规则3-1-9】变量和参数首字母小写,其后每个英文单词的第一个字母大写,其它小写。
例如:int recWidth;
【规则3-1-10】标识布尔型的变量或函数名称一般使用is作为前缀。
例如:void isFull();
【规则3-1-11】常量全用大写字母,用下划线分割单词。
const int MAX_LENGTH = 100;
【规则3-1-12】静态变量加前缀s_(表示static)。
static int s_initValue; /* 静态变量*/
【规则3-1-13】如果需要定义全局变量,则变量加前缀g_(表示global)。
例如:int g_howStudent; /* 全局变量*/
【规则3-1-14】函数名用大写字母开头的单词组合而成。由多个单词组成的标识符每个单词首字母大写。其它小写。
例如:InputStudInfo(); //全局函数