documentation相关内容

sdk的swagger相当于什么?

是否有某种标准可供人们用来记录他们的库和框架? 理想情况下，它会使用 JSON 或 YAML，并允许生成呈现精美的 HTML 页面. 解决方案 SDK 文档最常见的方法是从源代码中的注释生成文档.这样，类/函数参考文档可以轻松地与实现保持同步. 有针对不同编程语言和框架的文档生成器.一些工具可以让您将生成的参考文档与手动编写的概念主题(概述、“入门"等)结合起来 一些流行 ..

发布时间：2022-01-22 18:10:59 documentation swagger 其他开发

如何使用 Swagger\OpenAPI 记录 GraphQL?

如何使用 Swagger 记录 GraphQL?我们有一个庞大的后端 REST API，最近部分开始使用 GraphQL.我们使用 Swagger 来记录 API. 问题是:如何使用 Swagger(OpenAPI) 来记录 GraphQL 端点?Swagger 或 GraphQL 的官方文档中绝对没有相关信息. 解决方案 GraphQL API 通常通过 GraphQL 服务器本身 ..

发布时间：2022-01-22 17:49:38 rest graphql swagger documentation openapi 其他开发

Swagger 可以根据现有的快速路由自动生成其 yaml 吗?

我继承了一个现有的 API，我想大张旗鼓地记录它，但我还不知道它的全部范围.Swagger(或其他中间件/工具)能否根据现有的快速路由自动生成 yaml(用于 swagger)? 对于我在其他问题上看到的情况，这似乎主要是一项手动工作，但我正在仔细检查这里是否有人找到解决此问题的方法. 解决方案 我在自动生成 Swagger json 和为我帮助构建的 API 手动编写它方面都有经验 ..

发布时间：2022-01-22 17:45:05 node.js rest express documentation swagger 其他开发

使用 roxygen2 在单个文档对象中记录多个数据集

我正在寻找一个等效于 @describeIn 的工具，它允许我为多个 R 数据对象创建一个文档对象. 我曾希望是这样的: #' 树的距离#'#' 这些数据集包含集合之间的距离#' 的 10-tip、11-tip 和 12-tip 树.#'#' @name treeDistances#' @keywords 数据集“treeDistances10"“treeDistances11"“tree ..

发布时间：2022-01-21 13:03:01 r dataset documentation documentation-generation roxygen2 其他开发

Xcode 和 XIB 自我文档

是否有记录许多 Xcode 绑定、outlet 和 IBAction 绑定、键值绑定等的工具?我看过 Doxygen 和 HeaderDoc，但是这些文档程序文件，用来描述类等，但似乎没有涵盖 Xcode 拖放启用的大量“隐藏"链接? 一个具体的例子，我可以使用 XIB 编辑器为我窗口上的每个控件创建一个 IBAction，创建一个或多个类/实例中的方法，定义在一个或多个文件中 - 我想要所 ..

发布时间：2022-01-20 21:45:04 objective-c ios xcode4 ide documentation 移动开发

记录依赖树

我需要在 vb6/dotnet 应用程序中记录程序集依赖项. 哪些技术/工具适合执行此类文档. 我打算使用 Visio 进行绘图. 解决方案 首先，尝试 Dependency Visualizer.我还使用 GraphViz 的 Dot 和一些自定义代码来生成简单的依赖项.自定义代码递归调用 SysInternal 的depends.exe 并解析输出..NET Reflect ..

发布时间：2022-01-20 19:31:41 .net vb6 documentation visio C#/.NET

使用 jsdoc 记录匿名对象和函数的最佳方式

编辑:从技术上讲，这是一个两部分的问题.我选择了涵盖一般问题的最佳答案，并链接到处理特定问题的答案. 用 jsdoc 记录匿名对象和函数的最佳方法是什么? /*** @class {Page} 页面类规范*/var 页面 = 函数() {/*** 从服务器获取页面* @param {PageRequest} pageRequest 您要请求的页面上的信息* @param {function ..

发布时间：2022-01-18 21:06:38 javascript documentation tags jsdoc 前端开发

如何在 Pod 和 perldoc 中使用 Unicode 字符?

我需要在我的 perl 文档中使用 utf-8 字符.如果我使用: perldoc MyMod.pm 我看到奇怪的字符.如果我使用: pod2text MyMod.pm 一切都很好. 我使用 Ubuntu/Debian. $ 语言环境LANG=de_DE.UTF-8LC_CTYPE="de_DE.UTF-8"LC_NUMERIC="de_DE.UTF-8"LC_TIME="de_D ..

发布时间：2022-01-18 13:49:41 perl unicode documentation internationalization perldoc 其他开发

一个 .Rd 文件中的多个功能

短版:我可以使用 roxygen 来模拟 stats 包中 Normal 的文档吗? 长版:我正在开发一个包，并试图通过在一个标题下收集许多具有通用输入/参数的函数来使文档更具可读性，这将是一个通用参考到组.每个功能仍应可供最终用户独立使用. 我以 Normal 的文档为灵感，该文档提供了许多与正态分布相关的方法，例如stats::dnorm(). 当我搜索 ?dnorm 时，我 ..

发布时间：2022-01-13 17:23:33 r documentation package roxygen roxygen2 其他开发

在 R 包文档 (.Rd) 文件中包含图像

我正在努力在我的一个包中记录一个可视化功能.为此，我希望通过 Rd 文件“funcname.Rd"嵌入一个图像，该图像可以解释函数中使用的各种参数，如果用户阅读包手册 PDF 或写入“?funcname"，该图像会弹出' 在 R. 中的一些东西: 'Writing R extensions'-document 似乎没有解决这个问题，我能找到的唯一参考资料是 这篇博文 和 这个 R-devel ..

发布时间：2022-01-13 17:15:27 r documentation package visualization rd 其他开发

记录 Scala 2.10 宏

我将从一个例子开始.这是 Scala 2.10 中作为宏的元组的 List.fill 的等价物: 导入 scala.language.experimental.macros导入 scala.reflect.macros.Context对象元组示例 {def fill[A](arity: Int)(a: A): Product = macro fill_impl[A]def fill_impl[A ..

发布时间：2022-01-11 20:00:09 scala macros documentation scala-2.10 scala-macros 其他开发

如何将 Rust 宏变量嵌入到文档中?

我想在宏生成的文档中使用一个宏变量: 宏规则！impl_foo {($name:ident) =>{///返回一个新的 `$name`.fn myfoo() ->$名称{}};} 但是，变量不会被替换.我也尝试使用 #[doc] 属性: 宏规则！impl_foo {($name:ident) =>{#[doc = concat!("返回一个新的`", $name, "`.")]fn myfo ..

发布时间：2022-01-11 19:30:37 macros documentation rust 其他开发

创建“添加到 Google 日历"需要哪些参数?关联?

我们可以使用这个链接到添加新事件到Google日历 按参数 https://www.google.com/calendar/render?动作=模板&文本=事件名称&日期=20131206T050000Z/20131208T060000Z&location=EventLocation&sprop=名称:名称&sprop=网站:EventWebite&详细信息=事件详细信息&sf=真&输出=xml ..

发布时间：2022-01-11 13:52:29 calendar documentation google-calendar-api document 其他开发

哪些工具可用于记录 jQuery 插件?

我最近开始创建一些 jQuery 插件，我发现很难使用我找到的文档生成工具来记录它们.我试过了:JSDoc, JSDoc-toolkit、JGrouse 和一个基于网络的工具还.我最头疼的是我的插件被编码为一个大的匿名函数，我无法让工具识别我在做什么，或者完全忽略它，让我输入方法的文档标签、对象等. 还有其他工具可以帮助记录 jQuery 插件吗? 谢谢，桑德罗 解决方案 你看 ..

发布时间：2022-01-11 13:35:53 javascript jquery documentation jquery-plugins 前端开发

如何本地化 .NET 库的文档

我有一个开源项目(这里)，其 文档 目前为法语.该文档是使用 Sandcastle 从代码中的 XML 注释生成的.现在我想将文档翻译成英文并提供两种语言的文档，但我真的不知道从哪里开始...... 我是否需要从代码中提取 XML 注释并将它们放在单独的文件中?如果是，是否有任何工具可以自动化该过程? 我正在使用 Sandcastle Help File Builder 构建文档；我需要创 ..

发布时间：2022-01-11 10:36:49 c# .net localization documentation sandcastle C#/.NET

如何理解在 PyTorch 中创建叶张量?

来自 PyTorch 文档: b = torch.rand(10, requires_grad=True).cuda()b.is_leaf错误的# b 是由将 cpu Tensor 转换为 cuda Tensor 的操作创建的e = torch.rand(10).cuda().requires_grad_()e.is_leaf真的# e 需要梯度并且没有创建它的操作f = torch.rand( ..

发布时间：2022-01-06 19:49:38 python pytorch documentation Python

在使用 Sandcastle 构建期间自动生成 html 文档

我需要采取哪些步骤才能通过 Visual Studio 中的构建步骤自动构建 HTML 文档?我已经准备好了所有的评论和正在生成的 comments.xml 文件，并安装了 Sandcastle.我只需要知道在构建后步骤中添加什么即可生成文档. 解决方案 自从提出这个问题以来，已经进行了一些更改.Sandcastle 不再包含 SandcastleBuilderConsole.exe.相反 ..

发布时间：2022-01-05 19:39:39 c# visual-studio-2008 documentation sandcastle C#/.NET

Node.js 请求对象文档?

这是一个非常直接的问题，但我在 Google 上没有找到任何内容.我正在寻找有关 Node.js 的 create server 函数中请求参数的文档，但我找不到任何东西. http.createServer(function(request, response){console.log(JSON.stringify(request));}); 使用 JSON.stringify() 调试给我 ..

发布时间：2022-01-05 15:23:35 node.js documentation request 其他开发

Xcode 8.2.1 未显示有关自动完成的文档说明

我在 Xcode 8.2.1 中向我的代码添加文档时遇到问题. 这是我的代码: ////测试文档方法//////- 参数字符串:输入字符串///- 返回:输出布尔值func testMethod(string:String) ->布尔{如果字符串==“是"{返回真}返回假} 文档在快速帮助窗口中按预期显示，但描述未在代码自动完成窗口中显示. 有没有办法让描述显示在自动完成框中，如下 ..

发布时间：2022-01-05 12:52:45 swift xcode autocomplete swift3 documentation 移动开发

F# 文档是否可以按类型搜索函数?

说我想知道F#有没有类型的库函数 ('T -> bool) ->'T 列表 ->整数 即，计算一个函数返回 true 的列表中有多少项的东西.(或返回第一个返回真项的索引) 在 MSDN 上的文档准备好之前，我曾经在 MSR 站点上使用 F# 的大列表.我可以在页面上搜索上述文本，因为列出了类型.但是现在 MSDN 文档只在各个页面上列出类型——模块页面是一堆描述性文本.谷歌有点工作，但 ..

发布时间：2022-01-05 10:15:35 search documentation f# types 其他开发