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

bvjxkvbb 于 2022-11-09 发布在其他

关注(0)|答案(2)|浏览(154)

我一直在Yii框架上开发一个Web应用，其中大约60%的代码是用javascript编写的。在开发过程中，我无法同时创建功能/代码等的文档，但它只是在代码旁边写了一些非结构化的注解。
我想在HTML文档中自动生成我的Web应用程序的文档，该文档显示与代码混合的注解。

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

如果有人能提供一些关于从源代码和注解自动生成文档的指导，那将是非常有帮助的。
非常感谢！！

yii

来源：https://stackoverflow.com/questions/20966249/how-do-i-auto-generate-documentation-of-yii-based-web-application

2条答案

按热度按时间

xsuvu9jc1#

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

赞(0）回复(0）举报 2022-11-09

gz5pxeao2#

最后我使用了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>

* /

赞(0）回复(0）举报 2022-11-09

我来回答

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

2条答案

相关问题

热门标签

最新问答