嵌入式开发:编码风格、用户界面设计与汇编语言使用
1. 编码风格概述
编码风格指的是源代码的通用格式和风格方式。对于什么是好的编码风格,很容易陷入无休止的争论。其实,好的风格是适合你实际情况的风格,关键在于在整个项目中始终如一地遵循某种风格。
1.1 一致编码风格的重要性
一致的编码风格能让非原程序员更容易理解代码。它使开发者能更专注于代码的正确性等关键问题。代码可能有多个读者,如其他开发者、设计评审人员、测试人员和代码维护人员。因此,花些时间让代码更易读是值得的。
1.2 可能的症状
以下情况表明有必要改进编码风格:
- 没有书面的编码风格指南。对于小团队,虽可达成口头共识,但缺乏书面指南往往意味着存在问题,且可能伴随其他症状。
- 没有标准的头块注释风格。编码风格通常要求在每个文件开头包含特定信息,如文件名、内容摘要等。若每个文件开头差异大,其他方面的风格可能也不一致。
- 注释程度差异极大。有些文件可能完全没有注释,而有些文件的注释比代码还多。
- 变量命名约定差异大。部分代码可能大写变量名,部分则不这样做;有些会在变量名中体现数据类型,有些则不会。
1.3 缺乏书面编码风格指南的风险
不一致的编码风格可能带来以下风险:
|风险|说明|
| ---- | ---- |
|增加代码交接时间|风格一致的代码比风格差异大的代码更容易学习。|
|增加缺陷率|良好、一致的风格有助于减少低级错误。|
|增加检查成本|良好、一致的风格使代码在评审时更易理解。|