审查C++代码规范

简介：
遵循C++开发规范进行代码审查1. 范围 3 2. 规范性引用文件 3 3. 术语和定义 3 4. 开发工具 3 5. 目录结构 4 6. 布局规范 5 6.1. 对齐 5 6.2. 代码行内的空格 7 6.3. 空行 8 6.4. 代码行 9 6.5. 长行拆分 10 6.6. 注释 11 6.6.1. 概述 11 6.6.2. 基本规则 11 6.6.3. 函数注释（序言性注释） 13 6.6.4. 程序注释（功能性注释） 15 7. 命名规则 17 7.1. 共性规则 17 7.2. 一般命名规则 17 8. 文件结构 19 8.1. 概述 19 8.2. 版权和版本的声明 19 8.3. 头文件的结构 20 8.4. 定义文件的结构 21 9. 注意事项 22 9.1. 布尔变量与零值比较 22 9.2. 整型变量与零值比较 23 9.3. 浮点变量与零值比较 23 9.4. 指针变量与零值比较 23 9.5. 第三方工具的使用 23 10. SQL代码规范 24 10.1. SQL语句格式 24 10.2. SQL性能优化 24 10.2.1. WHERE子句中的连接顺序 24 10.2.2. SELECT子句中避免使用“*” 24 10.2.3. 减少访问数据库的次数 24 10.2.4. 使用DECODE函数来减少处理时间 25 10.2.5. 用Where子句替换HAVING子句 26 10.2.6. 减少对表的查询 26 10.2.7. 使用表的别名(Alias) 27 10.2.8. 用EXISTS替代IN 27 10.2.9. 用索引提高效率 29 10.2.10. 避免在索引列上使用计算 31 10.2.11. 避免在索引列上使用IS NULL和IS NOT NULL 31 10.2.12. 使用UNION-ALL和UNION 32 ### 审查代码规范(C++) #### 一、范围 #### 一、范围 #### 一、范围 本规范主要面向C/C++编程领域，在软件开发过程中明确了若干基础性编程风格原则及技术规范要求。它不仅对程序设计的基本思想和实现方式进行指导，还规定了开发环境配置、项目结构规划以及代码编写的具体规则等方面的内容。该文件信息包含以下规范性引用文件： 1. GB/T 19783-2016《汽车产品设计开发通用技术规范》； 2. GBT 19783.1-2015《汽车产品制造工艺通用技术规范》。这些标准主要在汽车产品设计、制造和服务等相关领域中得到具体应用。 基于以下文件作为依据对本规范的相关内容进行引用： - GBT5271.1-2000 信息技术词汇 第1部分：基本术语 - GBT5271.7-1986 数据处理词汇 07部分：计算机程序设计 - GB/T 5271.15-1986 数据处理词汇 15部分：程序设计语言 这些文件支撑了本规范的基础理论和先进技术背景，并有助于开发者更有效地理解和应用各项规定。三、术语和定义本规范中的专门术语及其解释部分基于以下标准： - GBT 5271.1-2000 - GBT 5271.7-1986 - GBT 5271.15-1986以下定义旨在为文章中涉及的专业术语提供具体的解释，从而使读者更容易理解相关规范的具体要求。四、开发工具 开发涉及的资源，这些资源需要在特定的时间内完成任务。 $...$原样保留，在限定时间内完成任务。 通过提高效率和提升性能，我们能够更好地优化系统的稳定性。 所有使用的工具都具备高效处理工作流的能力，并且支持多平台使用以确保系统正常运作。 - **编译器**：GCC 4.4.4版本。我们采用了GCC 4.4.4版本作为编译器，它在跨平台兼容性和支持多种编程语言方面表现优异，特别适合CC++开发者使用。 - **版本控制**：SVN (Subclipse)。基于团队协作的需求，我们选择了SVN作为版本控制系统。该系统不仅有助于记录代码变更的历史信息，还能轻松跟踪问题并追溯修改过程。 - 提交代码时需附带清晰的日志说明，以记录每一次变更的具体内容。 - 提交粒度应该控制在一个完整的功能实现，避免过于频繁的琐碎提交。 - 提交日志应当使用统一的动词开头，例如“添加”、“移除”或“修改”，这样能够更清晰地表达变更内容。 - **数据库**：ORACLE 10.2.1版本。为了确保应用功能的稳定性和可靠性，建议采用ORACLE 10.2.1版本作为数据库。该数据库系统具有良好的稳定性，能够有效支持复杂的应用场景。 第五部分 目录设置 第五部分 目录设置 第五部分 目录设置 **一级目录**：将一级目录命名为各业务组对应的英文缩略词。 **第二级子目**则主要用于分类不同种类的业务需求。 第三级子目则专门针对具体的代码编写规范。 特别提示：在项目架构中，不允许创建四层以上的目录结构。所有目录名称均应使用小写字母，并且建议在项目结构中的第二级及第三级目录之下设立一个名为common的专用目录，以存储共用资源。若在同一层级中需要同时存储文件和子目，则需严格遵循特定的组织原则。 六、布局规范 - **对齐**：保证代码元素呈现整洁布局。 - **代码行内的空格**：适当增加空白区域有助于提升可读性。 - **空行**：合理安排空白段落能有效分隔独立的逻辑块。 - **代码行**：每条指令控制在80个字符以内，以保持良好的视觉效果。 - **长行拆分**：遇到语句过长的情况，应考虑适当分解为多行结构。 - **注释** - **概述**：说明部分需简洁明了地提供必要的背景信息。 - **基本规则**：遵循原则确保注释位置合理，避免冗余现象。 - **函数注释**：对函数进行详细说明包括参数、返回值等内容。 - **程序注释**：为复杂算法或逻辑机制配上功能描述性解释，助于理解实现原理。 #### 七、名称规范 为了确保命名的一致性与科学性，本方案将对所有变量和数据集进行统一的命名策略。 在具体实施过程中，需要严格遵守以下基本要求： 1. 变量名应使用小写字母，并建议采用单一字母表示。 2. 数据集名称需明确其所属领域或应用场景，例如：用户行为数据、市场趋势分析 3. 所有术语必须遵循统一的命名规范，避免重复使用相似词汇。 务请注意以下事项： 1. 命名规则需要在开发初期就进行详细规划。 2. 持续跟踪现有命名系统的实践效果。 3. 定期对命名标准进行必要的调整与优化。 4. 在迁移过程中确保原有命名体系的兼容性。 - **共性规则**：命名时应尽量不用缩写形式，并选择具有明确意义的名字，以避免产生歧义。 - **一般命名规则**：变量名、函数名等应遵循具体的命名规范，通常建议采用驼峰式命名法或使用下划线分隔的格式来提高可读性。 八、文件结构 该目录下包含多个子目录，请按照下面所述的规则进行管理。每个文件夹应命名为$A_1B_2C...$的形式，其中字母部分代表分类信息，数字部分则表示排序依据。为了确保资源的组织性与可访问性，建议采用以下路径缩略语：根目录为BaseDir，数据存储区为DataFolder，中间结果存放位置设在TempSub。 文件命名格式应遵循如下原则：所有字符必须区分大小写，并且字母字段优先按照分类信息进行排序。对于包含多个子文件夹的主文件来说，请确保其路径结构简单明了，避免嵌套过多层级以提高访问效率。此外，建议对所有文件进行加密处理，具体方法请参考附录中的技术文档。 在实际操作过程中，请特别注意以下几点：首先，在创建新目录时必须先生成相应的缩略语标识符；其次，所有文件的命名格式须保持一致，并确保路径结构符合规范要求。对于包含多个子文件夹的主文件来说，请确保其路径结构简单明了，避免嵌套过多层级以提高访问效率。 - **概述**：文件应遵循统一的结构模式，以确保管理与维护的便利性。 - **版权和版本声明**：该文件顶部需包括 copy-right 信息及 version 标识。 - **头文件结构**：明确其基本架构，确保统一的标准和标准化流程。 - **定义文件结构**：对源文件的结构进行详细规划，涵盖必要的注释与 head 包含。 第九部分 注意事项 第九部分 注意事项 **布尔变量与零值比较**：更倾向于以逻辑形式进行比较而不是数值计算。 **整型变量与零值比较**：同理可得，建议采用布尔运算符处理。 **浮点变量与零值比较**：考虑到浮点型数据的精度限制，推荐使用误差范围来判断是否为零值。 **指针变量与零值比较**：特别提醒，在实际应用中慎选第三方工具，并严格验证其安全性与可靠性。 十、SQL代码规范 - **SQL语句格式**：确保SQL语句结构统一，便于阅读和维护。 - **WHERE子句中的连接顺序**：科学规划连接顺序能够有效提高查询性能。 - **SELECT子句中避免使用“*”**：明确选择所需字段以减少数据传输量。 - **减少访问数据库的次数**：通过批处理技术降低对数据库的访问频率。 - **使用DECODE函数来减少处理时间**：借助DECODE函数优化条件判断逻辑，提升运行效率。 - **用WHERE子句替换HAVING子句**：改用WHERE子句可以避免不必要的计算开销。 - **减少对表的查询**：利用索引技术降低无谓的数据扫描次数。 - **使用表的别名**：通过别名简化SQL语句，提高代码可读性。 - **用EXISTS替代IN**：在判断数据是否存在时，选择EXISTS通常比IN更高效。 - **用索引提高效率**：合理配置索引能够显著优化查询性能。 - **避免在索引列上使用计算**：这将导致索引失效并增加查询时间。 - **避免在索引列上使用IS NULL和IS NOT NULL**：同样会导致索引失效，应予以规避。 - **使用UNION-ALL和UNION**：根据具体需求选择合适的集合操作方式以提升查询效率。 该份C/C++代码审查指南旨在系统性地涵盖开发者在选择开发工具和进行编码实践中需要遵循的关键原则与步骤。其主要目标是确保开发出符合标准且易于维护的代码。严格遵守该指南所述的各项原则和步骤，能够有效提升项目总体质量和技术水平。