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

我一直在开发一个基于Yii框架的Web应用程序，其中约有60％的代码在javascript中。在开发过程中，我无法创建功能/代码等的同步文档，但它只是与代码一起编写的非结构化评论。如何自动生成基于Yii的Web应用程序的文档

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

我试图yiidocumentor但输出是更Yii的本身的文档和它不记录JavaScript函数
Docco是貌似最好的解决方案，但它是用于的NodeJS基于应用和我尝试使用端口的Docco在php（sourceMakeup），但它没有显示任何错误，但没有显示任何结果。另外，为了使用sourceMakeup，我不得不将这些文件移到Yii框架之外，因为我无法在Yii框架内使用它。

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

非常感谢！

2014-01-07 Shivang Doshi

我终于使用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> 
*/

来源

2014-01-09 05:23:32

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

来源

2014-01-08 16:09:45 ShahRokh

thnks fr回复！ –

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

回答

相关问题