logo资料库

C语言编程规约(C语言编程规约).pdf

发布时间：2022-06-08 发布人：admin 分类：说明书 资料大小：0.19M 资料格式：pdf 举报 版权申诉
第1页 / 共13页
第2页 / 共13页
第3页 / 共13页
第4页 / 共13页
第5页 / 共13页
第6页 / 共13页
第7页 / 共13页
第8页 / 共13页
资料共13页，剩余部分请下载后查看
    蒋学平排版，此文章从网上搜索到的，用于学习。 1.0 简介 代码编写规则应该在建立在一个工程项目之前。该规则应该贯穿整个项目的始终以保证代 码的一致性。采用标准的代码编写惯例，可大大简化项目的维护负担。 在C语言中可以有多种代码的编写方法（当然其它编程序语言亦如此），你可以尽可能采用 一种好的风格，以达到以下目的： 可移植 (Portability) (Consistency) 连贯 整洁 (Neatness) 易于维护 (Easy maintenance) 易于理解 (Easy understanding) 简洁 不管你采用那种风格，我所强调的就是：这种风格一定要贯穿你项目的始终。在以后的内 容中我还要提到：即使在一个团队合作的大型项目中，这种风格也要贯穿始终。采用通用的代 码编写风格可以减轻代码维护的工作量并降低维护费用；这种通用的代码风格还可以避免重写 代码。本文将介绍我几年来一直采用的这种编码风格。 (Simplicity) 2005-4-28 Page 1 of 1
    蒋学平排版，此文章从网上搜索到的，用于学习。 2.00基本原则 制定标准的基本目的就是加强代码的可维护性。也就是说代码必须易于阅读，易于理 解，易于测试，易于移植。 所有的代码必须采用ANSI C标准 函数原型必须采用ANSI标准，因此，类型定义应包含在括号之内。 保持代码的简单清晰 不要在语言中使用晦涩难懂的表述，直接表明你的思想。 保持一致性 尽可能使用同样的规则。 保持标准的灵魂(Keep the spirit of the standards.) Where you have a coding decision to make and there is no direct standard, then you should always keep within the spirit of the standards. 避免使用复杂语句 一个语句若有太多的决策点（Decision points）将会使代码难于理解，尤其是对于测试。 不要使用GOTO语句 更新原有代码 一旦修改已存在的代码，就要随时更新相关文档以遵守本文中所制定的规则，这将确 保原有代码即时更新。 2005-4-28 Page 2 of 2
    蒋学平排版，此文章从网上搜索到的，用于学习。 3.00 源代码文件 代码行的长度 我不喜欢超过80个字符宽度的C程序代码行，只是因为我们过去的显示器只允许显示80个字 符的宽度。 一代码行的长度应考虑在一张8.5" X 11"的打印纸上以每英寸17个字符的压缩打印 模式打印的字符数量。在压缩模式下，你可以调整到132个字符并在页面左侧预留足够空间的装 订线位置。允许每行132个字符是避免有注释的源代码折行，如果确实需要超过132个以上的字 符才能使你的代码更清晰，那也未尝不可。我曾经写过超过300个字符宽度的初始化结构的代码 （存于ROM中）。当然，你可能看不到完整表格的内容，但至少会整齐的多。 [TAB]键的应用 一定不要用[TAB]键（ASCII 0x09）。若使代码缩排一定要用空格键[SPACE]（ASCII0x20）。 [TAB]键会在不同的电脑或打印机上显示会有所不同，避免这种现象出现，就是使用空格键代替 [TAB]键。 缩行步长： 4个空格 代码缩行步长以4个空格（ASCII 字符0x20）组成。注意“case”语句实际上应缩行5 个空格。 包含一个文件头 在每一个源代码文件的开始部分都应包含一个注释块，其内容应包括公司名称，地址， 版权，程序员，文件的描述信息等，参见以下示例： /* ******************************************************************************** * Micrium, Inc. * 949 Crestview Circle * Weston, FL 33327 * * (c) Copyright 2000, Micrium, Inc., Weston, FL * * All rights reserved. Micrium’s source code is an unpublished work and the * use of a copyright notice does not imply otherwise. This source code contains * confidential, trade secret material of Micrium, Inc. Any attempt or participation * in deciphering, decoding, reverse engineering or in any way altering the source * code is strictly prohibited, unless the prior written consent of Micrium, Inc. * is obtained. * * Filename : * Programmer(s): Joe Programmer (JP) * John Doe (JD) * Created : YYYY/MM/DD * Description : ******************************************************************************** */ 一个完整的程序文件是一个包含可执行语句文件，而头文件则不是。这两种文件看起 来很相像，如下所示。一个程序文件将包含部分或全部以下内容。 执行文件的布局: File heading Revision history (文件头) (版本更新纪录) 2005-4-28 Page 3 of 3
    蒋学平排版，此文章从网上搜索到的，用于学习。 #include (包含文件) #define constants (常量定义) Macros Local data types Local variables Local tables Local function prototypes(局部函数原型) Global functions Local functions (宏定义) (局部数据类型定义) (局部变量) (局部表单) (全局函数) (局部函数) (文件头) (版本更新纪录) 头文件布局: File heading Revision history #define constants (常量定义) Global macros Global data types (全局数据类型定义) Global variables Externals Global function prototypes(全局函数原型) (全局变量) (外部定义) (全局宏定义) 分隔各主要段落 每段应以一个以下示例的注释块开始： /* ******************************************************************************** * DATA TYPES ******************************************************************************** */ typedef unsigned char BOOLEAN; /* ******************************************************************************** * PROTOTYPES ******************************************************************************** */ BOOLEAN OSIsTaskRdy(void); 头文件必须保证避免在包含文件中重复定义一个数值。 推荐使用#ifndef X.代替!defined(X) #if !defined(module_H) #define module_H Body of the header file. #endif /* End of module_H */ 2005-4-28 Page 4 of 4
    蒋学平排版，此文章从网上搜索到的，用于学习。 4.00 注释 Make every comment count. 保持代码与注释分隔清晰可见。 尽量少在语句间嵌入注释，永远不要将注释加在如下所示的代码之上。这会使代码难于理 解，因为喧宾夺主的注释会转移对代码的阅读。 void ClkUpdateTime (void) { /* DO NOT comment like this! */ /* Update the seconds */ if (ClkSec >= CLK_MAX_SEC) { ClkSec = 0; /* Update the minutes */ if (ClkMin >= CLK_MAX_MIN) { ClkMin = 0; /* Update the hours */ if (ClkHour >= CLK_MAX_HOURS) { ClkHour = 0; } else { ClkHour++; } } else { ClkMin++; } } else { ClkSec++; } } 不要将单句注释分隔成多行。 从来也不要这样做： /* This type of comment can lead to confusion especially when describing a function like ClkUpdateTime (). The function looks like actual code! */ 使用注释块分隔代码段。 参见以下注释块。注意一个注释块的主题应以大写字符形式居中。 /* ******************************************************************************** * VARIABLES ******************************************************************************** */ 2005-4-28 Page 5 of 5
    蒋学平排版，此文章从网上搜索到的，用于学习。 Use trailing comments as much as possible. As much as possible, always start the trailing comment on the same column. If the code goes beyond the selected column, place the comment on the line just above while still starting at the same column. As much as possible, line up the terminating comment charaters. Using trailing comments allows the code to be visually separate from the code. void ClkUpdateTime (void) { if (ClkSec >= CLK_MAX_SEC) { /* Update the seconds */ ClkSec = 0; if (ClkMin >= CLK_MAX_MIN) { /* Update the minutes */ ClkMin = 0; if (ClkHour >= CLK_MAX_HOURS) { /* Update the hours */ ClkHour = 0; } else { ClkHour++; } } else { ClkMin++; } } else { ClkSec++; } } 使用 #if 0 和 #endif 注释代码块。 注释不可以嵌套，使用#if 0 和 #endif来注释一段较大的代码 #if 0 /* Comments out the following code */ #define DISP_TBL_SIZE 5 /* Size of display buffer table */ #define DISP_MAX_X 80 /* Max. number of characters in X axis */ #define DISP_MAX_Y 25 /* Max. number of characters in Y axis */ #define DISP_MASK 0x5F #endif 2005-4-28 Page 6 of 6
    蒋学平排版，此文章从网上搜索到的，用于学习。 5.00 命名规则 通用规则 #define constants: #define macros: typedefs: enum tags: 用下划线分隔所有大写的单词. 例如: DISP_BUF_SIZE, MIN(), MAX(), etc. 局部变量(函数作用域): 全部使用小写单词并以下划线分隔. 使用标准变量名称(也就是: i, j, k 用于loop循环计数, p 用于指针变量等.) 一个文件作用域内的变量: 以模块名称跟一个下划线为前缀,单词间以首字母大写分隔 静态变量声明 例如: Disp_Buf[], Comm_Ch, 等. 全局变量: 以模块名称作为变量的前缀. 如果是多个单字组成的名称每个单前缀字母要大写 例如: DispMapTbl[], CommErrCtr, etc. 局部函数: 以模块名称与下划线为前缀,单词间首字母大写. 静态声明: 例如: static void Comm_PutChar() 全局函数: 以模块名称为前缀单词间首字母大写. 例如: void CommInit() 使用首字母大写分隔名称中的单字(e.g. DispBuf[]). 原有代码中只含有小写字符的必须以下划线分隔(i.e. ‘_’, ASCII 字符0x2D). 使用规范化的缩略词/缩写词助记符。 建立一个标准规范的缩略词/缩写词和助记符詞典应用于整个项目。以下表格所列的是部分 首字缩略詞/缩写词助记符字典的示例，另外在再做成一个相同内容的反向排序的缩略詞/缩写 词助记符字典列表。 缩略词/缩写词和助记符使用“模块-对象-操作”的格式。 当创建一个全局的常量，变量和函数标示符的时候，先指定一个模块(或者子系统)的名 称并跟随其对象和动作。参见以下示例：, OSSemPost() OSSemPend() etc. 英文原词 Argument Buffer Clear Clock 首字缩略/或缩写词助记符字典 中译文 自变量 缓冲区 清除 时钟 首字略词或缩写词 Arg Buf Clr Clk 2005-4-28 Page 7 of 7
    蒋学平排版，此文章从网上搜索到的，用于学习。 Compare Configuration Context Delay Device Disable Display Enable Error Function Hexadecimal High Priority Task I/O System Initialize Mailbox Manager Manual Maximum Message Minimum Multiplex Operating System Overflow Parameter Pointer Previous Priority Read Ready Register Schedule Semaphore Stack Synchronize Timer Trigger Write 比较 配置 上下文 延迟 设备 禁止 显示 使能 错误 函数 16进制 高优先级任务 输入输出系统 初始化 信箱 管理器 手册 最大 消息 最小 复合 操作系统 益出 参数 指针 前 优先级 读 待命 寄存器 调度 信号 堆栈 同步 定时器 触发器 写 Cmp Cfg Ctx Dly Dev Dis Disp En Err Fnct Hex HPT IOS Init Mbox Mgr Man Max Msg Min Mux OS Ovf Param Ptr Prev Prio Rd Rdy Reg Sched Sem Stk Sync Tmr Trig Wr 坚持使用标准的缩略词/缩写词或词助记符 尽管你可以书写完整的单词，但也要坚持使用缩略词/缩写词或助记符。 例如：总是用Init代替Initialize。 2005-4-28 Page 8 of 8
    分享到：
    赞 收藏

    相关推荐

    资料库

    课程资源

    共收录17145份资料，累计13个分类，关注成员有19位，主要包括：PHP,网络管理,网页制作,Java,.Net,数据库,3G/移动开发,C/C++,游戏开发,嵌入式,讲义,软件测试,专业指导

    热门标签

    PHP 网络管理 网页制作 Java .Net 数据库 3G/移动开发 C/C++ 游戏开发 嵌入式 讲义 软件测试 专业指导

    最新资料