Question

我正在创建一个PHP微框架，并决定使用ApiGen来生成API。当我使用＆＃34; apigen＆＃34;在终端上命令，我得到以下消息：

sh.exe＆＃34;：apigen：命令未找到。

也许是目录树：

Project/
--Libraries/
----Attw/ (micro-framework and the directory to document)
----apigen/

我该怎么办？如何组织目录树？我怎样才能正确执行apigen？我还没有找到关于此的好教程。

Answer 1

我自己一直在与Apigen稍微挣扎（它曾用于生成一个空的文档），但最后我使用https://github.com/apigen/apigen/downloads上的独立版本（在Windows上）使用它。（更新：也可以为Netbeans配置apigen）

例如在d:\apigen

打开包装

现在找到并重命名apigen.neon.example到apigen.neon并在标准文本编辑器中打开这个neon配置文件。如果您希望它与Netbeans一起使用，您还需要填写params作为源和目标。想必要添加inc扩展名。因此，找到extensions:行并将其更改为extensions: [php, inc]

打开Windows命令行界面（cmd.exe）并转到d：\ apigen 现在运行类似：

apigen --source e:\wamp\www\ --destination e:\apigen_output --config d:\apigen\apigen.neon

现在应该生成您的文档。

在Netbeans（8.0）中，首先转到工具，选项，PHP，框架和＆amp; apigen.bat的工具，apigen和设置路径。现在右键单击您的项目，选择属性，apigen，然后从上面选择配置文件。然后右键单击您的项目并单击Generate Documentation。

作为另一种方式，我也看到人们在PHP路径中解压缩ApiGen，如e:\wamp\bin\php\php5.5.12 然后，在Windows中转到计算机＆gt;属性＆gt; <进步系统设置> （制表符）高级＆gt;环境变量。在第二个系统变量列表中找到路径，单击编辑并添加这样的内容到最后：;E:\wamp\bin\php\php5.5.12\不要忘记分号。

Apigen现在应该可以从cmd全局获得。

Answer 2

从版本4.0开始，您可以将ApiGen作为PHAR下载并使用它与使用composer的方式非常相似。

有关详细信息，请结帐apigen.org

我无法安装和运行ApiGen

2 个答案: