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

Question

我安装了Magento，我想知道如何生成完整的API文档，例如http://docs.magentocommerce.com/上使用phpdoc生成的文档。 Magento for phpdoc中是否包含可用于生成文档的配置文件？

Answer 1

实际程序称为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已安装。

警告：由于Magento是一个相当大的程序，因此生成所有 API文档可能需要一段时间。