首页
学习
活动
专区
圈层
工具
发布
    • 综合排序
    • 最热优先
    • 最新优先
    时间不限
  • 来自专栏Rust语言学习交流

    【Rust日报】 2019-12-27 alfred-rustdoc

    Read more alfred-rustdoc 幫忙快速查找 rust doc的工具 ? Read more ---- From 日报小组 @Damody

    53130发布于 2019-12-31
  • 来自专栏Rust 编程

    RustChinaConf 2022 大会议题回顾 | Part I : Rustdoc 你可以用它做什么以及它的未来

    本讲座[1]将介绍这些功能,让你了解rustdoc允许你做什么。 演讲摘要 什么是 rustdoc rustdoc 是和 Rust 编译器 rustc 一起提供的工具,用于生成代码的文档。 使用 rustdoc 进行文档测试 文档注释中的代码示例,可以通过 cargo test来运行,这是 rustdoc 提供的文档测试功能。 rustdoc lint rustdoc提供 lints 来帮助开发者编写和测试文档。比如: #! 关于 rustdoc 还有很多功能可以去 rustdoc book 中查阅。 book: https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html [6] Nightly 下 rustdoc 功能: https://doc.rust-lang.org

    83820编辑于 2022-12-08
  • 来自专栏Rust语言学习交流

    【Rust日报】2021-01-14 rustdoc的性能有了很大的提升!

    在过去四个月,rustdoc的性能有了很大的提升! ? 据jynelson回复,在接下来的几天,他将要发表一篇博客,给大家介绍这些性能提升是来自哪些地方。 Read More: https://www.reddit.com/r/rust/comments/kwlpv3/great_improvement_in_rustdoc_performance_in_the

    52210发布于 2021-01-21
  • 来自专栏福大大架构师每日一题

    Rust 1.93.0 更新正式发布:史上最细版本解读,语言特性、编译器、库与 Cargo、Rustdoc 全面革新!

    本次更新带来了语言层面的多项稳定特性、编译器优化、平台支持拓展、标准库改进以及 Cargo 和 Rustdoc 的实用增强。这一版本在性能、安全性和系统兼容性方面都有显著提升。 七、Rustdoc 改进 Rustdoc 文档生成器的体验进一步优化: • 移除 #![doc(document_private_items)]。 • 搜索过滤中包括 属性宏及派生宏。 如果这些属性值缺失、异常或类型错误,将触发默认拒绝(deny-by-default)lint —— rustdoc::invalid_doc_attributes。 • 当在无意义的地方(如 trait 方法或类型)使用 #[test] 属性时,编译器现将报错,不再忽略;同时 rustdoc 生成也会出错。 无论是编译器优化、Cargo 构建体验,还是 Rustdoc 文档一致性,都在此版本迎来全面进步。

    60210编辑于 2026-01-28
  • 来自专栏旅途散记

    听GPT 讲Rust源代码--src/librustdoc(2)

    rustdoc/html/mod.rs文件是Rustdoc的HTML生成器的入口点,它定义了HTML生成过程中的各种步骤和操作。 解析注释的过程是Rustdoc生成HTML文档的核心。 综上所述,rustdoc/html/mod.rs文件是Rustdoc工具的核心部分,负责解析注释、处理源代码、生成HTML文档以及处理错误和警告。 这些 trait 和结构体的作用是为了提供一个统一的方式将 rustdoc 中的数据结构转换为 JSON,或将 JSON 数据转换为 rustdoc 的数据结构。 提供插件机制:lib.rs文件还提供了扩展Rustdoc功能的插件机制。它定义了一些插件接口和相关函数,以方便用户编写自定义的处理逻辑,从而扩展和修改Rustdoc的行为。

    65710编辑于 2023-11-23
  • 来自专栏旅途散记

    听GPT 讲Rust源代码--src/librustdoc

    通过这个枚举,Rustdoc可以正确地解析和展示这些参数。 Rustdoc是Rust的文档生成器,用于从Rust源代码中生成文档。在生成文档时,Rustdoc会对源代码中的注释进行解析,并将其转换成HTML格式的文档。 具体来说,该文件中的代码实现了一个Pass类型,它会在Rustdoc文档生成的过程中被调用。Pass类型是Rustdoc中的一种处理过程,用于执行特定的功能。 该文件使用Rustdoc库提供的功能,如rustdoc::clean和rustdoc::clean::Item来处理文档树。 该fixture文件用于测试Rustdoc工具对"union"关键字的代码高亮功能的正确性。Rustdoc是用于Rust源代码生成文档的工具,它能够将Rust源代码转换为易读的HTML文档。

    74010编辑于 2023-11-22
  • 来自专栏TensorFlow从0到N + Rust

    Rust API 指南:文档

    所有条目都应有一个rustdoc示例(C-EXAMPLE) 每个公共模块,特型,结构,枚举,函数,方法,宏和类型定义都应具有一个示例,用于该功能的练习。 该准则应在合理范围内适用。 以#开头的行是在构建示例时通过cargo test编译的,但不会出现在用户可见的rustdoc中。 不要显示无用的实现细节(C-HIDDEN) Rustdoc应该包括用户完全使用crate所需的一切。 尤其要选择在rustdoc可以看到哪些实现--所有用户需要使得能完全使用crate。 在以下代码中,默认情况下,PublicError的rustdoc将显示From <PrivateError> impl。

    2.6K30发布于 2020-12-10
  • 来自专栏旅途散记

    Rust项目中的Labels

    690 T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.与 rustdoc 团队相关 84 A-rustdoc-ui Area: rustdoc UI (generated HTML); 区域:rustdoc UI(生成的 HTML) 84 I-heavy/太重 Problems and Area: Rustdoc JSON backend领域:Rustdoc JSON后端 35 A-reproducibility/再现性 Area: Reproducible / Deterministic /rustdoc搜索 Area: Rustdoc's search feature区域:Rustdoc 的搜索功能 25 WG-compiler-parallel/编译器并行 Working group [特征(负值实现)] 15 A-synthetic-impls/综合impls Area: Synthetic impls, used by rustdoc to document auto traits

    39910编辑于 2024-02-26
  • 来自专栏Rust语言学习交流

    【Rust日报】 2020-09-18 rustup CI 现在正在构建 aarch64-musl

    讨论: https://www.reddit.com/r/rust/comments/iumwxu/aarch64musl_now_being_built_by_rustup_ci_enabling/ rustdoc 文档内链接接近 stable 文档内链接是rustdoc的一项特性,可让你通过其名称而不是硬编码的URL链接到“项”(函数,类型等)。

    51051发布于 2020-09-23
  • 来自专栏Rust语言学习交流

    【Rust日报】2021-01-20 rust GUI 编程介绍

    rustdoc团队更新 更换了团队leader,以及其他一些其他成员信息的变更 https://blog.rust-lang.org/inside-rust/2021/01/19/changes-to-rustdoc-team.html

    1.2K10发布于 2021-01-26
  • Rust 1.51.0 稳定版本改进介绍

    Rust 1.51.0 改进包括语法、编译器、类库、稳定 APIs、Cargo、Rustdoc、Misc,以及兼容性方面。 语法改进 常量泛型(const generics)。 Rustdoc Rustdoc 将包括 Deref trait 中的可用方法的文档。 可以提供一个标志 --default-theme,用于设置文档的默认主题。

    1.1K10编辑于 2022-06-30
  • 来自专栏福大大架构师每日一题

    rust 1.92.0 更新详解:语言特性增强、编译器优化与全新稳定API

    本次版本更新在语言特性、编译器、标准库、Cargo、Rustdoc 等多个方面都有重要改进与优化。以下是详细内容。 一、语言层面更新 1. 六、Rustdoc 改进 1. 搜索项优化 当 trait 项出现在搜索结果中时,Rustdoc 将隐藏对应的 impl 项。

    29910编辑于 2025-12-19
  • 来自专栏繁依Fanyi 的专栏

    【Rust 基础篇】Rust 文档注释

    文档生成和查看 Rust 提供了 rustdoc 工具来生成和查看代码的文档。rustdoc 是一个文档生成工具,它可以从代码中提取文档注释,并生成 HTML 格式的文档。 要生成代码的文档,我们可以在项目的根目录下运行以下命令: $ cargo doc 运行上述命令后,rustdoc 将会扫描代码并生成文档到项目的 target/doc 目录中。

    79540编辑于 2023-10-12
  • 来自专栏phodal

    API 库的文档体系支持:主流编程语言的文档设计

    起先,我只分析过 Rust 语言中的 rustdoc,分析它是如何自动化处理相关文档的。后来,联想到了其它语言的文档形式是不是也会类似。 如 Rustdoc 会编译、运行文档中的代码,可以通过 Rust 自身提供的断言语法(如 assert_eq!)进行测试。 Rust 语言的语法块(如果没有标注语言类型,默认是 Rust) 根据语法块,做一些简单的处理,生成可编译的代码 编译上述的测试代码 (如果编译失败,则说明测试失败) 运行这些测试 or 文档 如下是 Rustdoc 详细见 Rustdoc 相关源码:librustdoc 构建文档体系:markdown 即 DSL 基于上述语言的文档体系,我们就能浮现出基本的原型。

    1.1K20发布于 2021-10-14
  • 来自专栏Rust语言学习交流

    【Rust日报】2022-12-28 Rust 中的原生反射

    the code snippets /// /// ```mermaid /// graph LR /// s([Source]) --> a[[aquamarine]] /// r[[rustdoc located in place of the code snippet /// /// Dark mode is automatically enabled if `dark` or `ayu` rustdoc

    70420编辑于 2023-02-15
  • 来自专栏繁依Fanyi 的专栏

    【Rust 基础篇】Rust Cargo 自定义构建

    演示了如何配置发布选项: [package] name = "myapp" version = "0.1.0" edition = "2018" [package.metadata.docs.rs] rustdoc-args 我们还使用 [package.metadata.docs.rs] 键来配置文档生成工具 rustdoc 的选项,例如禁用默认选项、自定义传递给 rustdoc 的参数。

    75420编辑于 2023-10-12
  • 来自专栏福大大架构师每日一题

    Rust 1.90.0 发布:新特性、编译器改进与兼容性更新详解

    本次更新在语言特性、编译器、平台支持、标准库、Cargo、Rustdoc 以及兼容性方面带来了重要变化。本文将为你详细解读这些更新。 round_ties_even Cargo • 添加 http.proxy-cainfo 配置,用于代理证书 • cargo package 使用 gix • 发布(publish):稳定化多包发布功能 Rustdoc 的精细化控制,增强了常量与内存交互的能力;编译器现在对 Linux x86_64 默认使用 lld 链接器,并对部分目标默认启用动态链接;标准库与 const API 覆盖面继续扩大;Cargo 和 Rustdoc

    24810编辑于 2025-12-18
  • 来自专栏旅途散记

    听GPT 讲Rust源代码--src/bootstrap

    File: rust/src/bootstrap/bin/rustdoc.rs rust/src/bootstrap/bin/rustdoc.rs这个文件是Rust编译器中用于构建文档生成工具rustdoc 这个文件的作用是定义了一个main函数作为rustdoc的入口点。当运行rustdoc时,这个文件会被执行,接受命令行参数,并传递给rustdoc程序。 它负责解析命令行参数,设置rustdoc的各项配置,并最终调用rustdoc的主要逻辑函数。 在生成文档的过程中,rustdoc还会处理一些特殊的注释标记,比如#[derive]、#[doc]等,以生成更准确和完整的文档内容。 总之,rust/src/bootstrap/bin/rustdoc.rs文件的作用是作为rustdoc的入口文件,负责解析命令行参数、配置rustdoc的各项属性,并调用rustdoc的主要逻辑函数来生成

    94570编辑于 2023-11-21
  • 来自专栏旅途散记

    听GPT 讲Rust Cargo源代码(3)

    File: cargo/src/bin/cargo/commands/rustdoc.rs rustdoc.rs文件是Rust编译器Cargo的源代码中的一个文件,它是cargo中的一个命令模块。 具体来说,rustdoc.rs文件定义了一个名为Rustdoc的结构体,该结构体实现了Command trait,使得我们可以使用Cargo命令行工具输入cargo rustdoc来调用rustdoc的功能 Rustdoc结构体中有一些字段和方法用于解析和执行rustdoc命令的参数。 在rustdoc.rs文件中,还定义了一些辅助函数,例如clean_format函数用于格式化生成的文档,execute_rustdoc函数用于执行生成文档的操作。 总的来说,rustdoc.rs文件的作用是作为Cargo命令模块,负责解析和执行rustdoc命令,从而生成Rust代码的文档。

    47710编辑于 2024-04-25
  • 来自专栏IT可乐

    Rust 从入门到精通02-安装

    self uninstall 5、查看本地文档 rustup doc 6、rustc rustup rustc 编译器,c++ 等同于gcc g++ rustup 管理编译器的工具,可以更新管理rustc rustdoc

    90220编辑于 2022-09-16
领券