c语言编程规约.doc

实用标准文案 精彩文档 文档编号 产品版本 密级 V1.0 必威体育官网网址 产品名称： C语言编程规约 (内部使用) 拟制： 日期： 审核： 日期： 审核： 日期： 批准： 日期： 修订记录 日期 修订版本 描述 作者  前言 编程规约应建立与一项工程支出，且该规约应贯穿整个工程之始终。采用一些规约有助于提供劳动生产率，并使团队工程软件便于维护。 惯用的、号的书写风格以及他人用的一些好方法。可以达到以下目的： 可移植性好 兼容性好 干净整齐 易维护性好 易看懂 简明扼要 无论采用什么样的编程风格，必须在整个工程中采用始终如一的格式。对于一项大工程的整个团队建议使用同一的编程风格。所以，本团队试用一下C语言编程规约来规范程序的书写方法。采用共同的编写风格，可以少发生一些程序维护中令人头痛的事情，降低维护成本；采用统一的书写方法有助于避免代码的重复编写。 C源代码的宽度限制在80个字符。使用Fixedsys字体9号字。源代码超出部分需要将源代码分成两行书写且将注释书写于头上。除了必要的英文外，本团队约定所有注释一律使用中文。不得使用英文及其它语言。 新来的团队人员在编写代码前应先认真阅读本规约。以便快速了解和掌握本关于软件编写规范。 文件头 以下是C语言程序的文件头。公司的名称和地址可写在前几行；然后是标题，标出文件的主题内容；接着是著作权声明，以表明软件的专有权。 然后是关于侵权的警告说明及购买本软件的联系方式。 /******************************************************************************* XXXXXXXX有限公司 * CN_uOS实时操作系统 * * 此文件属于CN_uOS实时操作系统的一个子文件，XXXXXXXX有限公司对其有所有版* 权及保留意见。任何复制和发布本软件的公司及个人，我们将对其追究最终法律责任。 * 需要使用部分或全部软件代码的公司及个人需同XXXXXXXX有限公司联系。 * 网址： * * 文 件 名： * 版 本： * 描 述： * 作 者： * 日 期： * 函数列表： ******************************************************************************/ 文件包含 应用工程需要的头文件紧跟在版本变更记录的后面。本团队约定将所有头文件包含在一个名为includes.h的头文件中。除了因要发布为库的头文件外，所有的应用程序头文件都应遵循此约定，不得例外。 文件包行的注释格式为： /******************************************************************************* 头文件 ******************************************************************************/ #include “includes.h” 标志符命名法 变量名申明应该是每行一个变量，而不要在一行中声明多个变量，这样易于给每一个变量加上注释。 形式参数：在函数中应只用小写字母 自动变量名：应只用小写字母 静态变量和函数：应使用文件名或模块名（或部分文件名、模块名）为前缀。大小写字母混用。 外部变量和函数：应使用文件名或模块名（或部分文件名、模块名）为前缀。大小写字母混用。 缩写、略语及助记符 在给变量和函数等标志符命名时可以使用缩写、略语及助剂符。使用缩写可以使较少的字符描述标志符。但容易引起混乱和误解。为保证其正确性。团队要求，在每个工程项中应使用一张助记词表作为说明。以便查阅。 一本有效的词典对于一个团队来说可以提供劳动生产率。不仅是在单独的程序中，应在整个工程项目中始终保持前后一致。 助记表格式如下： 缩写、略语及助剂符