编程基本规范

发表于 2025-10-18 11:16

优先使用位操作代替乘除法，宏定义代替函数调用以减少资源占用

发表于 2025-10-18 11:51

模块内部函数和变量用 static 修饰，仅暴露必要接口（通过 .h 声明），减少全局变量依赖。

发表于 2025-10-18 12:35

函数应当尽可能独立，职责单一，方便复用和测试。

发表于 2025-10-18 12:57

减少全局变量使用，必须时通过static限定作用域。

发表于 2025-10-18 14:16

模块间通过函数接口通信，避免直接访问内部变量

发表于 2025-10-18 14:50

宏和常量使用全大写字母，单词间用下划线分隔

发表于 2025-10-18 15:29

按功能拆分模块，每个模块对应 .c 实现文件和 .h 头文件。

发表于 2025-10-18 16:45

使用assert或自定义宏验证关键参数

发表于 2025-10-18 20:17

注释需简洁准确，说明代码“做什么”而非“怎么做”，有效注释量建议占代码的30%左右

发表于 2025-10-18 21:28

代码的可读性是首要目标，应避免过度复杂和冗余，确保其他人也能轻松理解和修改。

发表于 2025-10-18 22:59

每个源文件开头应包含必要的注释信息，如项目名称、模块功能、编译环境、编程者、修改者和编程日期。这些信息有助于追溯代码的历史和理解其作用。

发表于 2025-10-20 22:30

C 源文件通常会有一个对应的头文件，用于声明函数和全局变量。使用 #ifndef/#define/#endif 宏避免重复定义，确保头文件在多个源文件中的正确使用。

发表于 2025-10-22 14:42

头文件：说明模块功能、接口用途及参数含义。
函数：说明功能、输入输出、返回值及注意事项（如是否可重入）。
关键代码：对复杂逻辑（如状态机、位操作）添加注释，无需注释显而易见的代码。

发表于 2025-10-23 19:48

对数组索引、缓冲区长度等进行范围验证。

发表于 2025-10-23 20:16

代码设计应考虑到未来可能的需求变化，允许在不大幅改动现有代码的基础上进行扩展。

[应用方案] 编程基本规范