rustdoc - 云端在线

程序：

您的姓名

rustdoc - 从 Rust 源代码生成文档

概要

生锈文件 [配置] INPUT

商品描述

该工具通过从源代码中提取注释来生成 API 参考文档
用 Rust 语言编写，可从 ⟨https://www.rust-lang.org⟩ 获得。 它接受
多种输入格式，并为生成的文档提供多种输出格式。

配置

-r, --输入格式 FORMAT
html 或 json（默认：推断）

-w, - 输出格式 FORMAT
html 或 json（默认：html）

-o, - 输出 OUTPUT
放置输出的位置（默认： 文档/ 对于 html， 文档.json 对于 json)

--通过 清单
要运行的以空格分隔的通行证列表（默认值：''）

--无默认值
不要运行默认的pass

--插件 清单
要运行的以空格分隔的插件列表（默认值：''）

--插件路径 DIR
从中加载插件的目录（默认： /tmp/rustdoc_ng/插件)

- 目标 三盒配套
目标三重到文档

--板条箱名称 您的姓名
指定这个箱子的名字

-L, --图书馆路径 DIR
要添加到 crate 搜索路径的目录

--cfg SPEC
通过 --cfg 生锈

--外部 VAL
通过一个 --外部 生锈

- 测试 运行代码示例作为测试

--测试参数 ARGS
将参数传递给测试运行程序

--html-标题 文件
要添加到的文件

--html-内容之前 文件
要添加的文件, 在内容之前

--html-内容后 文件
要添加的文件, 内容后

--markdown-css 文件
要包含的 CSS 文件在呈现的 Markdown 文件中

--markdown-游乐场-url 网址
将代码片段发送到的 URL

--markdown-无目录
不包括目录

-h, - 帮帮我
打印帮助

-V, - 版
打印 rustdoc 的版本

OUTPUT FORMATS

rustdoc 工具可以生成 HTML 或 JSON 格式的输出。

如果使用 HTML 格式，则指定的输出目的地将是根目录
所有文档的 HTML 结构。 页面将放置在此目录中，
并且源文件也可能会被渲染到其中。

如果使用 JSON 格式，那么指定的输出目的地将有 rustdoc 输出
将其序列化为 JSON。 这种输出格式的存在是为了预编译文档
crates，并用于非 rustdoc 工具。 JSON 输出是以下哈希：

{
“架构”：版本，
“箱”： ...，
“插件”：...，
}

模式版本指示板条箱/插件的结构是什么样的。 在一个
schema version 结构将保持不变。 这 箱 字段将包含所有
被记录的来源的相关文件，以及 插件 字段将包含
插件的输出运行在板条箱上。

示例

要为当前目录中的源生成文档：
$ rustdoc 你好.rs

列出 rustdoc 具有的所有可用传递，以及默认传递：
$ rustdoc --passes 列表

为 crate 预编译文档，然后使用它来渲染 html
日期：
$ rustdoc -w json 你好.rs
$ rustdoc 文档.json

可以使用任何标准 Web 浏览器查看生成的 HTML。

使用 onworks.net 服务在线使用 rustdoc