|
模块一定要有文档 通过这段时间苦逼的加班调式，我吸取了一些血的教训，在这儿和各位分享一下。觉得作为开发人员，尤其是写代码的同学，每完成一个模块都要有相应的文档。文档对于以后的调试和模块的调用以及代码的修改都灰常重要。 我个人认为文档分为这三类比较合适。
一、技术文档：
用来说明模块是怎么编写的，为什么要这么编写。这个在模块的编写之前就应该有个初稿，把模块编写的思路和步骤以及详细流程整理出来 。当然，第一次编写思路不一定是对的，这就要在以后的编写过程中不断的修改和完善文档。最好写成不同的版本。
用途：在N年以后，当你需要重新编写一个相同功能的模块的时候不会因为忘了当初的想法而重头来过。尤其是当现有程序出现bug的时候，不知道当时怎么写的，看半天都看不懂。如果看都看不懂，怎么调？
二、说明文档：
这个文档主要描述模块的功能，描述模块的输入输出，说明一些参数的设置及其意义。 比如我之前写的一个锁相环配置模块，调试的时候别人让我换个频率，我一听头都晕了，我已经完全不知道那些频率是怎么算来的。。。因为没有说明文档，我只能重新找到datasheet一个参数一个参数的对照，花了半个小时。如果有说明文档的话，往公式里面代入值，半分钟就可以解决的问题。
用途：测试和调试的时候用。有了这个文档，有些情况下测试人员自己都可以去修改参数的值 ，就算要自己去修改也会快很多。
三、调试记录：
说明文档一般是说明功能，而调试记录可以直接说明性能。 在调试和测试之前最好先把调试记录的表格先列出来。凭借多年经验，要想先测试，测完后再记录一般都不会记录，而且数据太多也很容易记混。记录的内容主要有：当前的板子用的是哪个版本的程序，有哪些功能，什么样的性能，用到的模块设置的参数分别是什么样的。。。还有日期和版本号。
用途：XXXX你懂的。
感觉完全表达不出我悟出真理时的那种豁然啊！！！你们能看懂么？希望对你们有帮助。
|
楼主
标题置顶
标题高亮
