Question

一个人的程序，你写开发文档吗？ - PHP进阶讨论

今天一个一年前的程序有bug需要修改，写完后就没有在动过它。自己看了很长时间才看懂当时的设计思路虽然有注释但已经不知所云了。当处写这程序的时候已经很有意识的进行注释说明了。记得当时整个流程弄的非常的完美和清晰，前期的思考做了很长时间，但现在还是忘记了。虽然也记录了一些文档但内容都是前期的分析思路和同类软件的分析的大概记录。(对这次记忆的恢复也起到了一定作用)请问：各位专业开发人员和做程序比较多的朋友，怎么弄文档可以在后期的时候可以轻松的浏览下就看的懂回忆起当初的设计思路呢？

Answer 1

也许你在看这些代码时是在考虑当时是怎么个思路，怎么想的，而不是在看这个代码是什么意思。记得以前高中时候做数学题和物理题，一进考场觉得似曾相识，结果反而半天做不出来，因为思维一直在考虑以前是怎么做的了，而不是去分析怎么做。自己的代码，如果不是开源发布，　估计没有必要有详细的开发文档吧，除非是很大的项目。也许你直按功能需求去分析，可能很快就分析出代码的含义了，也就容易记起以前是怎么个设计思路了

Answer 2

phpdoc文档要有,不管在个人还是团队开发,都有很好的帮助,主要是zendstudio对phpdoc的支持很好,我一般都是靠提示写代码的.提示直接提示出phpdoc的提示,非常方便.其实一个人也可以写出一个很大的系统.而且非常方便管理,只是比较累.我很喜欢一个人开发,开发的代码是自己一个人写出来了,非常有规则....反而让团队开发的时候有些人的思想与你不一样,写出来的代码乱七八糟,不好维护.

Answer 3

在一开始的思路整理阶段也使用了word进行记录和整理后期版本升级和功能增加时文档就跟不上了，有时由于文档和实际系统不协调反而造成了一些麻烦。

Answer 4

首先我会写一个商业逻辑文档，就是说这个模块这个功能他主要要实现什么样的功能，预期的效果是什么，会影响