电子信息行业研发部工程师代码编写工作手册（执行版）.docxVIP

电子信息行业研发部工程师代码编写工作手册（执行版）

第1章代码编写规范

1.1代码命名规范

代码命名是代码质量的基石。一个清晰的命名体系能显著降低团队协作的沟通成本。例如，在嵌入式系统开发中，一个命名混乱的传感器驱动接口可能导致数小时的无谓调试。

变量命名应遵循名词+动词的复合结构，如`temperatureSensorRead()`。避免使用缩写，除非行业标准明确要求（如`SPI`）。数字常量命名需带单位后缀，例如`voltage_5V`而非`voltage_5`。

函数命名需体现其核心功能，`calculatePowerFactor()`比`doCalc()`更直观。类名采用名词+名词结构，如`DataProcessor`。私有成员以`_`前缀标识，如`_configFlag`。

错误示范：`temp`（含义模糊）、`init`（功能不明确）、`x1`（无业务意义）。

1.2代码格式规范

格式一致性是团队协作的生命线。在FPGA代码中，每8位对齐的信号命名能避免数十个因错位导致的时序问题。

-缩进：统一使用4空格，禁止tab混用。

-换行：控制行宽在80-120字符间，函数声明后强制换行。

-分号：语句结尾必须分号，但连续注释块可省略（如`//thisis;thatis`）。

-空格：操作符两侧必须空格（`if