documentation 相关问题

此标签仅供文档生成器使用。还包括语言和/或SDE标记。请勿使用要求提供文档或工具的链接,或批评供应商文档。

将大量 HTML、示例代码和文本放入文档标签中?

我需要记录一个图书馆。但是,我似乎无法决定采取什么方法。我认为对我来说最重要的是文档(API 文档)始终是最新的并且......

回答 1 投票 0

用于创建 API 文档/提案的平台独立工具[已关闭]

有哪些工具可用于开发独立于平台的 API 文档? 我正在设计一个建议的 API,并且希望以结构化且易于编辑的方式编写文档。瞧...

回答 1 投票 0

速度 $fn 文档 [已关闭]

我注意到在我正在使用的一些 Velocity 报告中 $fn 包含一些 Velocity 的内置函数。我似乎找不到这些的列表。例如,$fn.formatNumber($fn.duration($time),'#...

回答 1 投票 0

clojure.lang等API [已关闭]

是否可以在线获取 clojure.lang 等的 JavaDocs?我需要自己从 Clojure 源代码构建它吗?

回答 2 投票 0

JavaDoc 到 (Doku)Wiki 转换/ doclet [已关闭]

我们公司有一个非常大的公共Java API,目前正在使用(当然)JavaDoc 独立和在线发布。它周围有链接到 API 的产品文档。 ...

回答 2 投票 0

如何生成 Magento 的 API 文档/文档?

我安装了 Magento,我想知道如何生成完整的 API 文档,例如 http://docs.magentocommerce.com/ 上使用 phpdoc 生成的文档。里面有配置文件吗

回答 1 投票 0

C# apidoc 类型查看器 [已关闭]

我正在寻找一个 C# 工具或 Visual Studio 扩展来可视化我使用的所有库的类型化 API(因为 MSDN 文档中没有类型,并且某些库没有 apidoc)。

回答 1 投票 0

以编程方式访问 Java 文档 [已关闭]

是否有 API 可以通过编程方式访问 Java 文档?类似于 Eclipse 等编辑器/IDE 为 IntelliSense 所做的事情。当然,javadoc生成的html可以被解析并且我...

回答 3 投票 0

生成 REST API 文档的最佳方法是什么? [已关闭]

我正在寻找一种为 REST API 生成文档的好方法。 它不需要实际连接代码或任何东西,但能够将文档编写为文本就太棒了

回答 3 投票 0

Sinatra 构建 REST API 文档 [已关闭]

我整晚都在寻找一个 gem 来从我的 sinatra 路由生成 API 文档。我应该能够用内联注释来指定。 我找到了 https://rubygems.org/gems/sinatra-api...

回答 2 投票 0

API 文档生成工具[已关闭]

我有一个在 RubyOnRails 上编写的 RESTful API(restfulie gem)。 从项目源生成 API 文档的最佳方法是什么?

回答 2 投票 0

Rails RESTfull API 文档

我正在寻找支持以下功能的文档框架: 从代码注释生成 可搜索 造型可定制 NTH:链接引用(如果我以某种方式引用一个类...

回答 2 投票 0

当前类的API文档预览

我对 Java 编程非常陌生,我决定更进一步,从 bluej(一种“特殊”的面向学生的程序)转向 eclipse。 我一直在错过一些我拥有的东西......

回答 1 投票 0

Doctrine / Swagger-php 语法错误:[语法错误]预期的 PlainValue,在位置 [关闭]

我正在尝试使用 Swagger-php,但我不断收到错误 通过bash: [用户名@dev swagger-php]$ ./bin/swagger [codeigniter控制器目录的路径]/controllers -o [目标输出路径]/swagger

回答 1 投票 0

未找到文档 - Apipie

我正在尝试运行生产服务器。几乎一切都正常,但 Apipie 的文档不能完美运行。 当我在开发环境中时,一切都很好。但在

回答 1 投票 0

带有基于命名空间的 ApiController 的自定义 ApiExplorer

我正在尝试在我的后端系统中添加API文档。 默认 ApiExplorer 和帮助页面工作得非常好,直到我向 API 控制器引入版本为止。 为了添加版本...

回答 3 投票 0

为我们的 JavaScript 库 API 编写文档 [已关闭]

我需要为我们的 JavaScript 库 API 编写文档并将其发布为 HTML(如 jQuery API 网站等)。 我认为有两种方法可以完成这项任务。 写下评论...

回答 2 投票 0

多维对象上的 JSONDoc 注释

我试图将 JSONDoc 中的注释放在多维对象上,但没有成功。 例子: @ApiObjectField(description = "带标志的多维数组") 私有布尔值[][]

回答 1 投票 0

是否有专为创建 REST API 参考文档而设计的 CMS 引擎? [已关闭]

我正在创建一个 REST API,用于与我们正在构建的新 SaaS 网站连接,我们需要记录该 API,以供第三方 iOS 开发人员(以及其他开发人员使用)

回答 2 投票 0

记录 Spring HATEOAS API [已关闭]

是否有任何插件(类似于 Swagger)可以提供记录 HATEOAS API 的功能? Swagger 界面非常好,但它没有 3 级 REST 支持。

回答 2 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.