过去几天我一直在使用 APIdoc.js,但我似乎无法弄清楚如何使版本控制工作。我知道我需要根据 APIDOC 将旧的 APIDOC 注释代码保存到另一个文件中,其中包含@APIVersioning
新/旧代码。无论我把这个旧文件放在哪里,我似乎都无法让它工作,而且这个例子中没有任何关于它如何加载旧代码来创建这个版本的提示。任何协助将不胜感激。
问问题
1448 次
2 回答
9
假设您已经创建了一个文件的文档,例如File1.php
. 现在,如果某些参数或可能需要在 中进行任何更改File1.php
,则只需将该文件的当前文档复制到_apidoc.js
并进行必要的更改。
再次生成文档File1.php
,并且BOOOM您现在有两个版本的文档。
请确保以下几点:
1)@apiVersion
在两个版本中放置具有不同值的标签。
2) _apidoc.js 应该在存在的同一目录中File1.php
。
于 2016-02-01T12:02:14.807 回答
3
http://apidocjs.com/上的相关信息可能更具体。经过一些实验,我发现您只需将_apidoc.js(如果您按照示例进行操作)与其余文件放在同一文件夹中。因此,如果您使用示例命令运行它:
apidoc -i myapp/ -o apidoc/ -t mytemplate/
然后_apidoc.js需要在myapp/中。
于 2016-01-13T13:14:21.850 回答