诸位前辈大家好，小弟要在弄懂一个linux下面大程序(C语言)，<br />想请教如何作文档<br />小弟是搞电子出身的，从来没学过软件工程方面的知识，<br />也不知道对于一个规模较大的程序需要有哪些文档来维护，<br />，以前的时候写的程序都不大，主要是一些在电路板上面<br />运行的硬件测试程序，因为代码量很小，也不用考虑什么版本的问题，<br />也不考虑编程习惯，可是最近由于工作需要，我需要看懂一个在<br />PC上面给linux系统写的免费的音频解码程序，规模挺大的。<br />自从在论坛里面看了那篇经典的“完全使用GNU/LINUX工作”以后<br />我也开始在linux下面进行我的学习和工作，现在我只要不调试<br />硬件的时候我就全在linux系统下面，但是我对于linux了解的只有<br />一些基本的系统管理和安装软件的知识。对于那个几万行的程序<br />我看起来真是无从下手，看懂局部可以，但是对于全局感觉还是<br />无法把握，往往是看懂了这里忘了那里.<br />        于是我感到要是想把握一个别人写出来的大程序，作好<br />关于该程序的阅读笔记是挺重要的。可是我不知道，在看程序<br />的时候应该如何记录，我觉得要作一些不同层次的记录，比如<br />说算法层次的和模块层次的，但是却不知道在作这些记录时<br />应当根据一些什么样的原则来把握。<br />        请大家指教，谢谢。

如果你仅仅想理解别人的程序写的笔记。哦的经验是掌握整个软件的大框架，然后逐步加深，逐层深入，从主流程到函数再到每个函数的具体实现 <!--emo&:)--><img src='style_emoticons/default/smile.gif' border='0' style='vertical-align:middle' alt='smile.gif' /><!--endemo-->

偶刚上手的时候，也是一推代码要读，<br /><br />偶自己一边读，一边画了个流程图，就都搞懂了~~

差不多这个样子<br /><br />软件中有概要设计与详细设计<br /><br />这两个的文档很重要<br /><br />概要就是知道系统分几个模块<br />实现原理是什么 <br />各模块间接口是什么<br /><br /><br />详细就是重要函数的接口是什么<br /><br />一般来说概要设计最重要 知道了软件的框架后就可以进行维护了 <br />如果是写别人的维护文档的话 写到这步也差不多了

同意无双的建议，我觉得你看得程序可能没有相关的文档，只能从程序本身去理解了。可以采用无双的建议，从结构框架开始，逐步细化，相当于反向工程了，呵呵！

谢谢诸位前辈的回复，小弟感觉受益匪浅，所以我觉得<br />我还是根据几位的建议，按照大家说的，先开始一边看<br />一边写文档，因为小弟以前没写过这类东东，所以在上手<br />写之前肯定不会把所有的问题都想到，我还是边练边学吧<br />，到时候有问题了再来向大家请教。<br />  祝各位圣诞快乐

先知道那个软件大概是什么写的<br />结构怎样<br /><br />分几个模块<br /><br />然后再看就方便多了

侯捷的那本剖析MFC结构的书中讲到了他的剖析经验，可作参考