我正在创建一个 PHP 微框架并决定使用 ApiGen 来生成 API。当我在终端上使用“apigen”命令时,我收到以下消息:
sh.exe": apigen: 找不到命令。
也许是目录树:
Project/
--Libraries/
----Attw/ (micro-framework and the directory to document)
----apigen/
我能做些什么?如何组织目录树?以及如何正确执行 apigen?我还没有找到很好的教程。
我自己在使用 Apigen 时遇到了一些困难(它曾经生成一个空文档),但最后我使用https://github.com/apigen/apigen/downloads上的独立版本让它工作(在 Windows 上) . (更新:也可以为 Netbeans 配置 apigen)
解压它,例如d:\apigen
现在找到 apigen.neon.example 并将其重命名为 apigen.neon 并在标准文本编辑器中打开这个 neon 配置文件。如果您希望它与 Netbeans 一起使用,您还需要填写参数作为源和目标。大概你想添加 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、框架和工具、apigen 并设置 apigen.bat 的路径。现在右键单击您的项目,选择属性、apigen,然后从上面选择配置文件。然后右键单击您的项目并单击生成文档。
作为执行此操作的另一种方法,我还看到人们在 PHP 路径中解压缩 ApiGen,例如e:\wamp\bin\php\php5.5.12
然后,在 Windows 中转到计算机 > 属性 > 高级系统设置 >(选项卡)高级 > 环境变量。在第二个系统变量列表中找到路径,单击编辑并在末尾添加类似这样的内容:;E:\wamp\bin\php\php5.5.12\
不要忘记分号。
Apigen 现在应该可以从 cmd 全局使用了。
从 4.0 版开始,您可以将 ApiGen 下载为 PHAR,并以与使用 composer 几乎相同的方式使用它。
欲了解更多信息,请查看 apigen.org