php - 有效地收集有关新 PHP 项目内部运作的信息。工具？技术？脚本？

Question

我即将加入一个经过数年开发的 PHP 项目。这将是巨大的、稀疏的文档、许多文件、成堆的代码，没有一致的质量水平是不可期望的。

您将如何收集尽可能多的有关正在发生的事情的信息？

• 预计不会自动加载，位于至少不广泛，所以 inclued可能会做得很好揭示相互依存关系。

• 拥有 phpDocumentor消化项目文件可能会给出一个想法关于哪些类/方法/函数都在场。

• 也许 phpCallGraph为了方法/函数关系。

• 分析一些通用用例 XDebug了解层次结构和概念。

• 正在检查重要的日志文件 ...检查警告，已弃用用法、错误。

• phpinfo() .

• 也许提取所有评论和将它们处理成一个 html 文件。

没有涵盖单元测试、数据库......

你会怎么做？您在使用上述工具以充分利用它们方面有哪些经验？

您可以假设任何必要的条件。

哪些统计信息可能对提取有用？

有人使用过这些工具吗？

编辑 来自 "PHP Tools for quality check" :

• PHP Mess Detector
• Copy/Paste Detector (CPD) for PHP code by Seb. Bermann

EDIT 2 来自 Bryan Waters 的回答:

• phploc - phploc is a tool for quickly measuring the size of a PHP project.

• 检查 Apache 日志和 Google Analytics 数据以找出请求最多的 URL，然后使用 XDebug 分析和类似 KCachegrind 的工具分析发生了什么.

• 具体技术见他的回答。

Setting up a deployment / build / CI cycle for PHP projects - suggested by Pekka

编辑 3

刚找到这个PDF Gabriele Santini 的演讲 - “代码的统计分析 - 聆听您的 PHP 代码”。这就像一座金矿。

Answer 1

我同意您的问题确实有大部分答案。

这就是我可能会做的。我可能会从 Sebastian Bergman 的工具开始，尤其是 phploc，这样您就可以了解您正在查看的困惑(代码库)的范围。它为您提供类、函数计数等，而不仅仅是代码行。

接下来我会查看 apache 日志或谷歌分析并获得前 10 个请求最多的 php url。我会通过分析设置 XDebug 并运行前 10 个请求并获取文件，调用 tree. (你可以用cachegrinder工具查看这些)

最后，我通读了其中一两个跟踪的整个执行路径，它们最能代表整体。我会使用我的 Eclipse IDE，但将它们打印出来并带着荧光笔去城里也是有效的。

如果有多个系统拼凑在一起，前 10 种方法可能会失败。您应该使用 Xdebug 快速查看前 10 个是否编码相似——是否每个都是一个独特的岛屿。

我会查看 mysql 数据库并尝试了解它们的用途，特别是查看表前缀，您可能有几个不同的应用程序堆叠在一起。如果数据库的大部分未被前 10 名触及，则您需要寻找子应用程序。如果您发现其他子应用程序通过 xdebug 探查器运行它们，然后通读代表该子应用程序的路径之一。

现在回过头来查看 phploc 中的范围编号，看看有多少代码库(可能是计数类或函数)在您审查期间未被触及。

您应该对最常运行的代码有基本的了解，并了解有多少角落、缝隙和壁橱用于骨架存储。