c语言编程及命名规范.ppt

C语言命名及编程规范
CXL

前言规范的重要性
今天人们越来越明白软件设计更多地是一种工程,而不是一种个人艺术。由于大型产品的开发通常由很多的人协同作战,如果不统一编程规范,最终合到一起的程序,其可读性将较差,这不仅给代码的理解带来障碍,增加维护阶段的工作量,同时不规范的代码隐含错误的可能性也比较大。
前言规范的重要性
BELL实验室的研究资料表明,软件错误中18%左右产生于概要设计阶段,15%左右产生于详细设计阶段,而编码阶段产生的错误占的比例则接近50%;分析表明,编码阶段产生的错误当中,语法错误大概占20%左右,而由于未严格检查软件逻辑导致的错误、函数(模块)之间接口错误及由于代码可理解度低导致优化维护阶段对代码的错误修改引起的错误则占了一半以上。可见,提高软件质量必须降低编码阶段的错误率。如何有效降低编码阶段的错误呢?BELL实验室的研究人员制定了详细的软件编程规范,并培训每一位程序员,最终的结果把编码阶段的错误降至10%左右,同时也降低了程序的测试费用,效果相当显著。
前言规范的重要性
本文从代码的可维护性(可读、可理解性、可修改性)、代码逻辑与效率、函数(模块)接口、可测试性四个方面阐述了软件编程规范;分为二个部分介绍,第一部分为命名规范,第二部分为编程规范。
本规范为天马公司强制执行项目。
前言规范的重要性
我们制定一种编程风格,希望能达到以下目的: 可移植(Portability) 连贯(Consistency) 整洁(Neatness) 易于维护(Easy maintenance) 易于理解(Easy understanding) 简洁(Simplicity)在一个团队合作的大型项目中,这种风格要贯穿始终。采用通用的代码编写风格可以减轻代码维护的工作量并降低维护费用;这种通用的代码风格还可以避免重写代码。
第一部分 C语言命名规范
一、通则
1、在所有命名中,都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角, 声母、韵母等。
2、所有命名都应遵循达意原则,即名称应含义清晰、明确。
3、所有命名都不易过长,应控制在规定的最大长度以内,一般不超过32个字节。
第一部分 C语言命名规范
一、通则
4、所有命名都应尽量使用全称。
5、如果命名使用缩写,则尽量应该使用通用缩写;如不知道通用缩写,则必须对其进行注释和说明。
6、缩写原则
形成缩写的几种技术:
1) 去掉所有的不在词头的元音字母。如screen写成scrn, primtive写成prmv。
第一部分 C语言命名规范
6、缩写原则
2) 使用每个单词的头一个或几个字母。如Channel Activation写成ChanActiv,Release Indication写成RelInd。
3) 使用变量名中每个有典型意义的单词。如Count of t。
4) 去掉无用的单词后缀 ing, ed等。如Paging Request写成PagReq。
5) 使用标准的或惯用的缩写形式(包括协议文件中出现的缩写形式)。如BSIC(Base Station Identification Code)、MAP(Mobile Application Part)。
第一部分 C语言命名规范
6、缩写原则
关于缩写的准则:
1) 缩写应该保持一致性。如Channel不要有时缩写成Chan,有时缩写成Ch。Length有时缩写成Len,有时缩写成len。
2) 在源代码头部加入注解来说明协议相关的、非通用缩写。
3) 标识符的长度不超过32个字符。
第一部分 C语言命名规范
二、具体规范
1、工程名
根据项目来命名,能反映项目的最主要特征。
例如:天马公司的Windows控制程序,项目名可命为TWIN
2、文件名
基于工程名,开头3个字母应表明与哪一个工程相关。
后面的字母应能够区别不同的功能。
严格区分大小写。
,建议不多于30个字符。
若文件用于定义和实现函数(类),建议文件名与函数(类)名保持一致。