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

【问题标题】：How do I auto generate documentation of Yii based web application如何自动生成基于 Yii 的 Web 应用程序的文档
【发布时间】：2014-01-24 19:37:58
【问题描述】：

我一直在 Yii 框架上开发一个 web 应用程序，其中大约 60% 的代码是用 javascript 编写的。在开发过程中，我无法同时创建功能/代码等文档，但它只是在代码旁边编写了非结构化 cmets。

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

我尝试了 yiidocumentor，但输出更多的是 Yii 本身的文档，它没有记录 javascript 函数
Docco 似乎是最好的解决方案，但它适用于基于 nodejs 的应用程序，我尝试在 php (sourceMakeup) 中使用 Docco 的端口，但它没有显示任何结果而没有显示任何错误。此外，为了使用 sourceMakeup，我不得不将文件移到 Yii 框架之外，因为我无法让它在 Yii 框架中工作。

如果有人可以提供一些关于从源代码和 cmets 自动生成文档的方向，那将有很大帮助。

非常感谢！！

【问题讨论】：

标签： javascript php yii documentation comments

【解决方案1】：

我最终使用了Natural Docs，因为它简单、高效并且支持多种语言。所需要的只是 cmets 中非常小的结构，即

/*
 Function: Multiply

 Multiplies two integers.

 Parameters:

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

 Returns:

  The two integers multiplied together.

 See Also:

  <Divide>
*/

【讨论】：

【解决方案2】：

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

【讨论】：