软件规范

MBC软件规范知识整理，包括：总体原则、头文件(.h)、源文件(.c/.cpp）三部分内容，希望对你有所帮助。

MBC软件规范

• 总体原则
  • 低耦合
  • 高内聚
  • 清晰第一
  • 简洁为美
• 头文件（.h）
  • 原则
    • 原则 1.1 头文件中适合放置接口的声明,不适合放置实现。
    • 原则 1.2 头文件应当职责单一。
    • 原则 1.3 头文件应向稳定的方向包含。
  • 规则
    • 规则 1.1 每一个.c 文件应有一个同名.h 文件,用于声明需要对外公开的接口。
    • 规则 1.2 禁止头文件循环依赖。
    • 规则 1.3 .c/.h 文件禁止包含用不到的头文件。
    • 规则 1.4 头文件应当自包含，自包含就是任意一个头文件均可独立编译。
    • 规则 1.5 总是编写内部#include 保护符(#define 保护)。
    • 规则 1.6 禁止在头文件中定义变量。
    • 规则 1.7 只能通过包含头文件的方式使用其他.c 提供的接口,禁止在.c 中通过 extern 的方式 使用外部函数接口、变量。
• 源文件(.c/.cpp
  • 函数
    • 原则
      • 原则 2.1 一个函数仅完成一件功能。
      • 原则 2.2 重复代码应该尽可能提炼成函数。
    • 规则
      • 规则 2.1 避免函数过长,新增函数不超过 50 行(非空非注释行)。
      • 规则 2.2 避免函数的代码块嵌套过深,新增函数的代码块嵌套不超过 4 层。
      • 规则 2.3 可重入函数应避免使用共享变量;若需要使用,则应通过互斥手段(关中断、信号量) 对其加以保护。
      • 规则 2.4 对参数的合法性检查,由调用者负责还是由接口函数负责,应在项目组/模块内应统 一规定。缺省由调用者负责。
      • 规则2.5 对函数的错误返回码要全面处理。
      • 规则2.6 设计高扇入, 合理扇出 小于 7 的函数
      • 规则2.7 废弃代码没有被调用的函数和变量要及时
  • 变量
    • 原则
      • 4.1 一个变量只有一个功能, 不能把一个变量用作多种用途。
      • 4.2 结构功能单一，不要设计面面俱到的数据结构。
      • 4.3 不用或者少用全局变量。
    • 规则
      • 4.1 防止局部变量与全局变量同名。
      • 4.2 通讯过程中使用的结构, 必须注意字节序。
      • 4.3 严禁使用未经初始化的变量作为右值。
      • 4.4 禁止使用单字节命名变量,但允许定义 i、j、k 作为局部循环变量。
  • 标识符
    • 原则
      • 3.1 命名要清晰、明了 , 有明确含义 , 同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。
      • 3.2 除了常见的通用缩写以外,不使用单词缩写,不得使用汉语拼音。
      • 3.3尽量避免名字中出现数字编号,除非逻辑上的确需要编号