我如何自动生成基于Yii的Web应用程序的文档

Question

我一直在开发基于Yii框架的Web应用程序，该应用程序中有大约60％的JavaScript代码。在开发过程中，我无法同时创建功能/代码等文档，但仅在代码旁边写有非结构化注释。

我想在HTML文档中自动生成Web应用程序的文档，该文档显示与代码混合的注释。

• 我尝试了yiidocumentor，但是输出更多是Yii本身的文档，并且没有在记录javascript函数的内容
• Docco似乎是最好的解决方案，但是它是针对基于Node.js的应用程序，我尝试在php中使用Docco的端口（sourceMakeup），但未显示任何结果且未显示任何错误。另外，为了使用sourceMakeup，我不得不将文件移到Yii框架之外，因为我无法使其在Yii框架中工作。

如果有人可以提供一些有关从源代码和注释自动生成文档的指导，那将有很大的帮助。

非常感谢！

Answer 1

我的建议是phpdoc .phpDocumentor是可以从您的PHP源代码生成文档的工具。

Answer 2

我最终使用了Natural Docs，因为它简单，高效并且支持多种语言。所需要做的只是在注释中提供一个非常小的结构，即

/*
 Function: Multiply

 Multiplies two integers.

 Parameters:

  x - The first integer.
  y - The second integer.

 Returns:

  The two integers multiplied together.

 See Also:

  <Divide>
*/

Answer 3

我会签出PHPFUI/InstaDoc。它将与任何框架一起使用。这是一个动态文档查看器。它是开发PHP应用程序的理想选择，因为您拥有当时实际上正在编写的新代码的所有当前文档以及所有旧代码，包括通过Composer引入的代码。它读取当前文件的doc块并动态呈现文档。因此，在签入代码之前，您实际上可以查看所包含的文档。经常查看文档，您会发现问题和可以解决的问题。因此，它使工作流程变得非常好。

InstaDoc可以为大量网站生成静态文件。您可以快速查看实际的PHP源以及该文件的git commits。该文档也是交互式的并且带有标签页，因此您可以仅查看感兴趣的部分，例如公共代码，而不是投影的功能。

使用您的作曲家文件，大约需要5行才能启动和运行InstaDoc。值得2分钟的设置，看看它是否对您有用。