如何处理尚未记录的现有项目？

我只从事过从头开始的项目，但现在我开始了一个没有文档和指导的预先存在的项目。所有参与该项目的人都离开了，我的客户希望我开始工作。常识是从主页开始，随着学习什么是什么以及它在哪里。如何处理尚未记录的现有项目？

该网站建立在Codeigniter（PHP）上，拥有超过500页的页面，最多有900-1100行代码，以及多个自定义选项。是否有任何有效且非耗时的方法开始？任何可能有帮助的工具？

2011-10-27 Rick Rhodes

号如果将有，为什么文件的一个项目呢？ – str

开始总是耗时。我会从应用程序目录下的控制器和视图开始 – galchen

检查某人的代码总是很困难。没有逃脱，你必须研究它。一些建议：1.像你说的，你最好的选择是从主页开始，逐步进入项目的内部。 2.使用一个好的IDE，以便您可以轻松浏览源文件，并从类，声明和实现中跳转（除非它最初制作的IDE具有所有这些）3.除非确定，否则不要急于更改任何内容你会得到整个图像，因为那样你永远不知道它什么时候会回复你。 4. SVN/GIT你的项目在做任何事之前。祝你好运。 –

我一直在这种情况一次或两次。我不认为有任何工具可以真正帮助您，因为文档通常是程序员和代码之间的粘合剂，但我没有真正寻找它们。

我的确有两个评论。首先，这会花费您很多时间。 A lot。基本上，你是逆向工程。在给出估算时（如果需要的话）考虑到这一点。

其次，你最好的选择是随时记录事情。你遇到的每一个功能，记录你认为应该做的事。这样，您可以回顾一下您已经检查过的功能，而无需再次检查它们。如果您不知道函数的内部功能是什么，请暂时保留并转到其他函数或方法。最后，如果没有任何文档，你所能做的就是在代码中执行程序，并在程序运行时（假设它运行），所以你可以猜测它应该是什么做。记录较小的功能，根据大的功能/类别工作。存储你遇到的任何笔记。在可能的情况下进行清理，但只有在您对清理的部分应该做什么的时候才有固体感。这可能需要一些时间。

不确定这真的有帮助，但这是一个糟糕的情况，我只能希望你的代码比文档更好。如果不是那么好，那么你还必须考虑重写零件的时间。

祝你好运。

来源

2011-10-27 17:29:01

使用对于获得可读/可浏览的项目结构大纲非常有用，它在标准安装中支持PHP。它会生成一个HTML文档，其中包含程序中各种依赖关系之间的超链接。

运行它很简单：

cd <project-top-level-directory> 
doxygen -g 
doxygen Doxyfile

来源

2011-10-27 17:42:33

如何处理尚未记录的现有项目？

回答

相关问题