专家分享：注释嵌入式软件的十大技巧

技巧4——提供使用例子以便更清楚地了解用途

　　函数或变量注释中包含如何使用它们的例子是很有用的。说应该如何使用是一回事，但展示如何使用会让人更清楚其用途。除了能够减少错误使用对象的机会外，还能给人一个更清晰的印象。图2显示了一个如何注释函数的例子，它告诉开发人员应该如何使用这个函数，从而避免了容易出错的猜测过程，使人能够更清晰地了解其用途。

　　图2——使用例子。

技巧5——创建注释标准

　　就像写代码一样，为代码开发注释和文档也应该有个标准。由于注释标准中不可能有许多条款，因此特别推荐向编写代码标准靠拢。也就是说确保小组中的每个成员以相同的方式进行注释和归档，从而确保开发的易用性。开发人员应该专注于解决手头的设计问题，而不是费劲地去搞懂注释。

技巧6——使用文档模板

　　确保注释遵循标准的最容易的方法是为头文件、源文件和支持文件创建模板。当创建一个新模块时，可以从模板入手，然后增加相关的信息。这将有助于确保文件信息块、代码段、函数和变量都用相同的格式注释。这种方法的最大优势是能够节省大量时间，并有助于减少将一个模块拷贝到另一个伪模板时发生的拷贝粘贴错误。为了让生活更加轻松，我特意开发了可以用于定义头文件和源文件的模板。

技巧7——图表的作用

　　在一个项目的软件实现阶段开始之前，应该有一个软件设计阶段。这个设计阶段无疑会生成许多漂亮的图(如流程图和状态机)，并被用于实际实现。虽然这些文档作为软件的开发路线图，但在开发和测试过程中总会出现偏差!遗憾的是，这些变化很少会返回到图表中。结果是设计文档和软件的不匹配!在实现和测试阶段将这些图表放在手边，以便发生上述偏差时这些图表能及时得到更新。将这些图表留到日后更新永远不是正确的做法。虽然我们总是有返回去更新或修复的良好愿望，但这永远不是合适的时机。