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

Question

4

我已经安装了Magento，并想知道如何生成完整的API文档，就像http://docs.magentocommerce.com/上使用phpdoc生成的那些文档一样。 Magento是否包含用于phpdoc的配置文件，以便我可以生成文档？

- user9903

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- user9903 · Accepted Answer

实际程序被称为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是一个相当大的程序。