C语言命名规范10条.doc

C语言命名规范10条
从事C语言的教学也有两年了,在教学中发现学生们在编程方面有一个极不好的习惯,就是随意命名,这不仅给自己日后阅读自己程序时带来不便,也给其他的程序阅读者带来麻烦,更重要的是没有统一的规范总显得像是个游击队,没有正规军的感觉,企业也不愿意要业余选手,所以C语言的初学者最好一开始就培养一种良好的编程习惯,也许日后进入公司有些改动,需要适应,但基本的规范和规则是不需要改的,这样可以帮助你少走很多弯路,经过这些年的学,便于传播,特总结为十条,建议读者采纳。
1) 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。
2) 不允许使用汉语拼音命名,更不要使用汉语,必须使用英文来命名标识符。尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。
3) 函数名、变量名从第二个单词起首字母大写。如:printName(), oldName等
4) 在C 程序中只使用const常量而不使用宏常量,即const常量完全取代宏常量。常量定义以大写字母K开头,字母全部使用大写,如:const int KSIZE = 100。
5) 代码缩进使用4个空格,不推荐使用TAB键
6) 版权和版本的声明位于文件的开头;函数头部应进行注释,列出:函数的功能、输入参数、输出参数、返回值等。关键代码注释位于被注释代码上方,且用空行与其他代码分割开,如:
文件头注释:
author: SDL team
function: testing hardware drivers and IDE
date:
copy right: Software College Of HeBei Normal University
函数注释:
function:SDL initial
parameter: none
return: bool