我安装了 Magento,我想知道如何生成完整的 API 文档,例如 http://docs.magentocommerce.com/ 上的文档是使用 phpdoc 生成的。 Magento 中是否包含用于 phpdoc 的配置文件,我可以使用它来生成文档?
最佳答案
实际的程序称为 phpDocumentor,您可以在命令行上使用它通过使用 phpdoc -d $MAGENTO_PATH/app/code/core/Mage/-t docs 来记录核心 Magento 代码
。不要忘记创建一个名为 docs 的目录,或者您可以将目标目录设置为您想要的任何目录。
要记录扩展的 API,您可以使用 phpdoc -d $MAGENTO_PATH/app/code/local/$PACKAGE/$MODULE
其中 $PACKAGE
是包name,$MODULE
是模块的名称,$MAGENTO_PATH
是 Magento 的安装位置。
警告:生成所有 API 文档可能需要一段时间,因为 Magento 是一个相当大的程序。
关于api - 如何生成 Magento 的 API 文档/文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6507759/