documentation - APIDOCJS - 如何创建版本控制

标签 documentation api-doc

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

最佳答案

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

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

请确认以下内容:

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

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

关于documentation - APIDOCJS - 如何创建版本控制,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32719671/

相关文章:

java - 如何在 Swagger 中添加有关 API 的更多信息?

java - 使用 swagger 创建 api 文档

c# - 如何复制 .NET API 文档?

python - 在 python 中检索对象的 'help' 文档字符串

delphi - 文档Delphi DLL导出

node.js - 如何记录使用 object.defineProperty 定义的 module.exports

documentation - 如何记录 makefile 模板并包含 *.mk 文件接口(interface)?

c++ - 尝试用 doxygen 记录二维相关的对象

documentation - 从 Tornado Web 服务器代码生成交互式 API 文档