EEPW论坛

在软件开发过程中没有比获得一个只有很少甚至没有说明文档的代码库而又要求进行维护更具挑战性的事情了。这些文档不只是告诉工程师某个特定函数或变量是做什么的，而且能够展示和传达软件为何以某个特定方式实现。在软件实现过程中会作出成千上万个决策，因此维护工程师甚至未来的你尽可能多地保留这些决策过程至关重要。smpeizi.com
　　注释代码的问题部分原因来自出货压力、不正确的设计以及注释代码是如何工作的事情没有开发来得有趣或兴奋这个事实！许多工程师（包括我自己）憎恨必须注释代码，但这项工作在嵌入式工程师开发过程中是如此重要，以致于我们绝对不能省略或三意二意地去做。然而，可以在软件开发过程中记住一些技巧，它们有助于确保未来开发人员维护好代码开发中的任何细微变动。aiidol.com 
　　技巧1——随时而不是过后进行注释
　　交付产品的压力经常导致天马行空般的编码风格，为了完成任务以便尽早推出产品，代码是想到哪就编到哪。在疯狂的代码编写过程中，很少想到记录下代码要完成的功能。等产品交货后，设计人员才会回去浏览代码并进行“注释”。这样做的问题是，这时已经距离写完代码几周甚至几个月的时间了！对一些工程师来说记起昨天早餐吃的是什么都很难，更不用说两周前写的一段代码了。最终结果是不准确的注释说明，日后往往会引起误解和缺陷。3sjtw.com 
　　这里的技巧当然是在进行决策的同时随时进行注释。形式化的外部文档注释过程无疑会降低开发人员的进度，但向代码库中增加注释真的不会占用更多时间。开发人员能够做的第一件事是先对代码要做什么事写一些注释行，然后再写代码。如果实现发生了变化，开发人员可以立即更新注释。在任何情况下，在编写代码的同时写下注释只会节省时间和增加条理性，从而更少发生错误，产品也能更快的上市。
　　技巧2——自动生成注释文档
　　尽管对代码做了很详细的注释，但总是有生成外部文档的要求，以便任何人不看代码就能明白程序功能。这个要求经常导致双倍的注释工作量。幸运的是，市场上有现成的工具可以自动读取代码注释、然后生成界面和代码的其它文档细节！帮助工程师避免必须做两次相同的工作！一个具有这种功能的免费工具例子是Doxygen。当开发人员在编写他们的代码时，他们以指定方式格式化他们的注释，并提供他们想要在外部文档中展示的细节内容。然后他们就可以运行Doxygen生成真实反映软件内注释的html、rtf或pdf文档。美妙的是如果你更新注释，外部文档也会自动更新！idiancai.com
　　技巧3——不要写显式的注释
　　虽然开发人员写了代码注释，但如果注释只是变量或函数名字的重复，会特别令人恼火。注释应该是描述性的文字，需要提供显式意思之外更多的细节！提供尽可能多的信息，而且不要忘了提及相关和关联的变量或函数。开发人员应该能够只通过阅读注释就了解软件的行为。图1给出了一个注释简单映射数组代码的例子。

　　图1：映射数组