如何为Magento生成API文档/文档？

发布时间：2020-12-13 16:12:23 所属栏目：PHP教程来源：网络整理

导读：我安装了Magento,我想知道如何生成完整的API文档,例如 http://docs.magentocommerce.com/上使用phpdoc生成的文档.是否有Magento for phpdoc附带的配置文件,我可以使用它来生成文档？解决方法实际程序称为phpDocumentor,您可以在命令行中使用它来使用phpdoc

我安装了Magento,我想知道如何生成完整的API文档,例如 http://docs.magentocommerce.com/上使用phpdoc生成的文档.是否有Magento for 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是包名,$MODULE是模块的名称,$MAGENTO_PATH是Magento已安装.

警告：生成所有API文档可能需要一段时间,因为Magento是一个非常大的程序.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!