APIDOCJS - 如何创建版本控制

时间:2015-09-22 14:31:07

标签: documentation api-doc

过去几天我一直在玩APIdoc.js,我似乎无法弄清楚如何使版本工作。据我所知,我需要根据APIDOC将旧的旧APIDOC注释代码保存到另一个{/ 1}}新文件中。无论我在哪里粘贴这个旧文件,我似乎无法让它工作,并且在这个例子中没有任何关于如何加载旧代码来创建这个版本的暗示。非常感谢任何协助。

2 个答案:

答案 0 :(得分:7)

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

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

请确认以下内容:

1)将@apiVersion标记与两个版本中的不同值放在一起。

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

答案 1 :(得分:3)

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

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

然后 _apidoc.js 需要在 myapp / 中。