linux平台软件代码编写规范10

《linux平台软件代码编写规范10》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、Linux平台软件代码编写规范日期：2⑽8.4.1日期：日期：（仅供内部使用）文档作者：说明书校对：项目经理：版权所有不得复制版本修改记录版本号曰期修改人修改内容V1.02觀.4.1创建本文档目录1觀41.1编写目的41.2主要lAl容41.3创建原则41.4适用范围41.5参考资料51.6术语和缩写词5253文件及其组织53.1文件分类及管理53.2文件命名63.3文件结构6“.c”、“.cpp”文件6h”头文件74酿74.1函数书写规范74.2阴数的局部变量和参数84.3函数的返回值84.4函数命名规则94.5函数的设计95变量及语句95.1命名规则95.1.

2、195.1.2宏、常景、枚举类型95.2书写规范105.2.1缩进105.2.2行宽105.2.3括号的位置105.3编码规则115.3.1全局变量115.3.2116awii7测试与调试128文年当128.1文档结构138.2开发文档131概述1.1编写目的为了统•-•规范公司的代码书写风格，使软件开发工程师能够比较容易的参考、查阅其他工程师开发的代码，也为了使软件项0的管理具有统一性、风格一致性，要求所有相关软件工程师都按照本规范的规定编写和开发软件。1.2主要闪容本规范主要描述了Linux平台下软件编写所遵循的规范，比较详细的叙述Z软件编写过程中的种种要求。

3、本规范从软件的架构要求、文件的分类、每个文件的格式、每个函数的定义格式、每个变y:的定义等等方而规范了软件的书写。详细内容见后而的相关章节。1.3创建原则本规范的制定本着方便实用的原则，从整体上对软件的书写格式加以规范；同时为了方便內部软件交流，又对部分细节加以约束，希望所有相关软件人员都按照此规范严格执行。当然，随着沟通的加深和项目的深入，本规范难免会有不适用的地方，同时也可能会产生新的要求，这些会随着后续开发的需要，不断加以修正。1.4适用范围本规范适用于全部Linux平台下的软件开发项目，包括该平台下的驱动等底层开发和应用程序开发，并适用于所有参与相关项目的

4、软件工程师。本规范目前从C语言程序设计角度建立该规范，对于其他语言请参考执行。本规范仅对自行开发的代码加以约束，对APT、系统调用、GNU库等无约束力。1.1参考资料〈〈Linuxkernelcodingstyle〉〉1.2术语和缩写词略2版本控制Linux软件项目的全部代码采用SVN服务器做版本控制，每个提交到SVN服务器的代码必须经过本地测试，并符合如下原则.•1）能够编译通过，不影响他人编译；2）模块功能确保基本正确，相应结构完整，无明显bug;3）无垃圾代码；4）文件结构清晰，注释清楚；5）满足本规范规定的全部要求。同时，开发人员在将代码提交到服务器之前，

5、必须在代码所在文件A填写相应的修改记录，同时在上传时填写该修订版本的增量修改FI志，便于FI后查询。所有人员的开发工作除非在软件出现重大bug,必须将代码回溯到较旧版本外，一般均要求全部开发必须基于最新版本完成，并提交代码。在出现耑要冋溯软件版本情况下，必须及时与项目经理沟通确认，并通知其他开发人员，避免由此造成的任何严重后果。SVN使用方法请参考其他文档。本文档不再详述。3文件及其组织3.1文件分类及管理对于lirwx平台下的软件开发，通常包括如下儿类文件:文件名扩展名管理人说明N/A•C模块负贵人C语言源程序N/A•CPP模块负责人C++语言源程序N/A•pi

6、模块负责人Perl语言源程序N/A.sh模块负贵人Shell脚本源程序N/A.h模块负责人头文件MakefileN/A注1Make工程管理文件注1:顶层MakeHle由项目经理统一规划修改，其他开发人W若作修改必须经项目经理确认。对于项目中出现的文件，必须严格采川上述扩展名命名机制对源代码加以区分。3.2文件命名1）项FI中出现的全部文件按照功能模块来划分。不论可能出现的文件的大小，每个模块都以一个“.c”文件的形式出现，命名为“模块名.c”，以下简称为“.c”文件；2）每个“.c”文件，必然有相同名字命名的“.h”文件。“.11”文件的名字与对应“.0”文件同名

7、，即“模块名.h”，以下简称为“.h”文件。“.h”文件的内容，一是定义本模块用到的相应的数据结构。二是将对应的.c文件的函数作声明，确保他人在调用该模块相应函数或功能时只需要包含对应模块的h”文件即可。3）特殊惜况：对于多个模块都需要使用的一些关键变量，比如说，定义显示语言的变量、日志信息的定义等，为了方便后來的修改，可以单独建一个.h企局变量头文件3.3文件结构3.3.1“.C”、“.cpp”文件“.c”、“.cpp”文件主要分为文件描述，全局变量声明、本文件范围内的变i的声明、函数的实现儿个部分。“.c”、“.cpp”文件以文件描述开始，内容包含该文件的作者

8、，主要功能