APIDOCJS - 如何创建版本控制

APIDOCJS - How to create versioning

过去几天我一直在玩 APIdoc.js,我似乎无法弄清楚如何进行版本控制。我知道我需要将我的旧 APIDOC 注释代码保存到另一个文件中,根据 APIDOC,在新/旧代码上使用 @APIVersioning。无论我把这个旧文件贴在哪里,我似乎都无法让它工作,并且在这个例子中没有任何关于它如何加载旧代码来创建这个版本的暗示。任何帮助将不胜感激。

http://apidocjs.com/ 上的相关信息可能更具体。经过一些实验后,我发现您只需将 _apidoc.js(如果您按照示例操作)与其余文件放在同一个文件夹中。因此,如果您使用示例命令 运行 它:

apidoc -i myapp/ -o apidoc/ -t mytemplate/

那么_apidoc.js需要在myapp/.

假设您已经创建了一个文件的文档,比如说 File1.php。现在,如果需要在 File1.php 中对某些参数进行任何更改或可能需要进行任何更改,则只需复制 _apidoc.js 中该文件的当前文档并进行必要的更改。

再次生成 File1.php 的文档,然后 BOOOM 您现在有两个版本的文档。

请确认以下内容:

1) 在两个版本中放置不同值的 @apiVersion 标签。

2) _apidoc.js 应该在 File1.php 所在的同一目录中。