软件开发代码规范(C语言).pdf

软件开发代码规范(C 语言) 关建字摘要：注释，命名，语句，代码，函数，空行，大写，空格，定义，单词 竭诚为您提供优质文档，本文已整理修正，内容完整 21 共 页，请先行预览，如有帮助感谢下载支持 *****高品质PDF ，可编辑可打印可自行转换***** XX 产品研究部 收文：XX 产品研究部软件开发人员 2011-5-11 第一章 原则 4 第二章 排版 5 2.1 空行 5 2.2 代码行6 2.3 代码行内的空格 6 2.4 对齐缩进 7 2.5 长行拆分 8 第三章 注释 10 3.1 通用规则 10 3.2 文件注释 10 3.3 函数注释 11 3.4 数据注释 12 3.5 代码注释 12 第四章 命名 15 4.1 通用命名规则15 4.2 文件命名 15 4.3 类型命名 15 4.4 变量命名 16 4.5 常量命名 17 4.6 函数命名 17 4.7 枚举命名 17 4.8 宏命名18 第五章 杂项 19 文件修改记录 2011-4-29 0.1 创建初稿 周超 1）修改3.4数据注释 【规则 3.3数据注释 3-4-3】全局变量注释例子 4.3类型命名 2）在 4.3类型命名”、 4.4变 2011-5-11 0.11 周超 4.4变量命名 量命名”、 4.6函数命名”中， 4.6函数命名 增加对前缀、关键缩写词等可以 适当全部大写的处理。 本文档的目的是提供一个公共的编码规范。 这个规范详细阐述在编码时要怎样写、不要怎样写，旨在提高代码的可读性、可维护性， 使代码易于管理，使所有人可以集中精力去实现内容，而非处理各种复杂的表现形式。 使代码易于管理的方法之一是增强代码一致性，让别人可以读懂你的代码是很重要的， 保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。创建通用的、 必需的习惯用语和模式可以使代码更加容易理解。虽然在某些情况下改变一些编程风格可能 会是好的选择，但我们还是应该遵循一致性原则，尽量不这样去做。 关键在于 l 在每个函数、结构体、枚举定义结束之后都要加空行。 l 在一个函数体内，逻辑密切相关的语句之间不加空行，其它地方应加空 行分隔。 struct st1 // 空行 { while (condition) … { }; statement1; // 空行 // 空行 enum