在软件开发进程中没有比取得一个只要很少乃至没有阐明文档的代码库而又要求进行保护更具挑战性的作业了。这些文档不仅仅告知工程师某个特定函数或变量是做什么的，并且可以展现和传达软件为何故某个特定方法完结。在软件完结进程中会作出不计其数个决议计划，因而保护工程师乃至未来的你尽可能多地保存这些决议计划进程至关重要。
注释代码的问题部分原因来自出货压力、不正确的规划以及注释代码是怎么作业的作业没有开发来得风趣或振奋这个现实!许多工程师(包含我自己)憎恶有必要注释代码，但这项作业在嵌入式工程师开发进程中是如此重要，以致于咱们肯定不能省掉或三意二意地去做。但是，可以在软件开发进程中记住一些技巧，它们有助于保证未来开发人员保护好代码开发中的任何纤细改变。
技巧1——随时而不是往后进行注释
交给产品的压力常常导致天马行空般的编码风格，为了完结任务以便尽早推出产品，代码是想到哪就编到哪。在张狂的代码编写进程中，很少想到记载下代码要完结的功用。等产品交货后，规划人员才会回去阅览代码并进行“注释”。这样做的问题是，这时现已间隔写完代码几周乃至几个月的时刻了!对一些工程师来说记起昨日早餐吃的是什么都很难，更不用说两周前写的一段代码了。终究结果是不精确的注释阐明，日后往往会引起误解和缺点。
这儿的技巧当然是在进行决议计划的一起随时进行注释。形式化的外部文档注释进程无疑会下降开发人员的进展，但向代码库中添加注释真的不会占用更多时刻。开发人员可以做的榜首件事是先对代码要做什么事写一些注释行，然后再写代码。假如完结产生了改变，开发人员可以当即更新注释。在任何情况下，在编写代码的一起写下注释只会节省时刻和添加条理性，然后更少产生过错，产品也能更快的上市。
技巧2——主动生成注释文档
尽管对代码做了很具体的注释，但总是有生成外部文档的要求，以便任何人不看代码就能理解程序功用。这个要求常常导致双倍的注释作业量。走运的是，商场上有现成的东西可以主动读取代码注释、然后生成界面和代码的其它文档细节!协助工程师防止有必要做两次相同的作业!一个具有这种功用的免费东西比如是Doxygen。当开发人员在编写他们的代码时，他们以指定方法格式化他们的注释，并供给他们想要在外部文档中展现的细节内容。然后他们就可以运转Doxygen生成实在反映软件内注释的html、rtf或pdf文档。美好的是假如你更新注释，外部文档也会主动更新!
技巧3——不要写显式的注释
尽管开发人员写了代码注释，但假如注释仅仅变量或函数姓名的重复，会特别令人恼火。注释应该是描述性的文字，需求供给显式意思之外更多的细节!供给尽可能多的信息，并且不要忘了提及相关和相关的变量或函数。开发人员应该可以只经过阅览注释就了解软件的行为。图1给出了一个注释简略映射数组代码的比如。
图1：映射数组。
