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

Question

我一直在Yii框架上开发一个网络应用程序，它有大约60％的javascript代码。在开发过程中，我无法创建功能/代码等的同步文档，但它只是在代码旁边写了非结构化的注释。

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

• 我尝试了yiidocumentor，但输出更多的是Yii本身的文档而且它没有记录javascript函数
• Docco似乎是最好的解决方案，但它适用于基于nodejs的应用程序，我尝试在php（sourceMakeup）中使用Docco的端口，但它没有显示任何错误而没有显示任何结果。 另外，为了使用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>
*/