38、嵌入式开发：编码风格、用户界面设计与汇编语言使用指南

嵌入式开发：编码风格、用户界面设计与汇编语言使用指南

1. 编码风格

编码风格指的是源代码的通用格式和风格方法。在探讨什么是好的编码风格时，很容易陷入无休止的争论。我们应采取更务实的方法，即适合自身情况的风格就是好的风格。关键在于在整个项目中始终遵循某种一致的风格。

1.1 一致编码风格的重要性

一致的编码风格能让非原程序员更容易理解代码的运行情况。保持风格一致有助于将注意力集中在真正重要的事情上，比如代码是否正确。一段代码可能有多个读者，包括其他开发者、设计评审人员、测试人员和下游代码维护人员。因此，花些额外时间让代码更易读是值得的。

1.2 可能的症状

以下情况表明有必要改进编码风格：
- 没有书面的编码风格指南。虽然小编程团队可以通过口头达成编码风格共识，但缺乏书面指南往往意味着存在问题，且可能伴随其他症状。
- 没有标准的头部块注释风格。编码风格要求每个文件开头包含特定信息，如文件名、文件内容摘要等。若每个文件的开头行差异很大，可能意味着文件的其他风格方面也不一致。
- 注释程度差异巨大。有些文件可能完全没有注释，而有些文件的注释比代码还多。
- 变量命名约定差异显著。程序的某些部分可能大写变量名，而其他部分则不然；有些可能在变量名中使用约定来表示数据类型，而有些则不使用。

1.3 无书面编码风格指南的风险

不一致的编码风格可能导致以下风险：
|风险|说明|
|----|----|
|增加代码交接时间|风格一致的代码比风格差异大的代码更容易学习|
|增加缺陷率|良好、一致的风格有助于减少低级错误|