标签: rustdoc

如何在文档代码中写一行,但让编译器忽略它？

我想写

/// # Examples
///
/// To clone something, do
///
/// ```
/// IGNORE_FOR_COMPILATION_BUT_SHOW: let cloned = myValue.clone();
/// # let cloned = 5.clone();
/// ```

我想得到:

例子

要克隆某事,做

let cloned = myValue.clone();

但编译器仍应编译示例(克隆5).

编辑:我也想要货物运行的例子,但遗漏一行.

我找到了rustdoc命令,我有点期待它的工作方式pydoc.不幸的是,rustdoc std::io:stdin没有做我想要的.有没有办法以离线形式查看标准库文档,通过命令行或某种内置的Web服务器,如Python的pydoc允许？

我已经使用条件编译来更改函数的类型签名,现在无法为两个"特性"模式运行相同的doctest,所以我需要一种方法来选择退出doctests.

我已经尝试#[cfg_attr(feature = "rss_loose", ignore)]在正常测试中使用合并并///rust,ignore制作,///rust,cfg_attr(feature = "rss_loose", ignore)但这似乎不起作用.

Markdown如何与rustdoc一起使用以包含图表或ASCII艺术？

通过阅读手册,三重反向标记可用于代码片段.如何包含文字的非格式化文本？

(像Doxygen的 东西<pre>...</pre>)

Rust的这部分内容似乎暗示可以将Rust文档保存在单独的.md文件中，但是没有说明如何将这些.md文件重新包含在内。这是如何运作的？

在https://doc.rust-lang.org/std/vec/struct.Vec.html#method.iter中，

我只能iter在页面左侧的索引侧栏中找到。但是，iter_mut找不到。

谁能解释这是故意还是错误？

这很不方便，因为从电话浏览时很难搜索文本。我正在滚动浏览索引，找不到iter_mut。

我正在为一个 rust 项目记录一个模块，其中包含 2 个lazy_static 宏调用，在评估由 Cargo doc 生成的文档时，我发现有一堆结构、静态和函数，旁边有一个锁，这些结构、静态和函数不在源代码中。有没有办法将它们隐藏在Cargo doc生成的文档中？ 问题图片。

我尝试将该#[doc(hidden)]属性添加到lazy_static 宏的调用中，但它不起作用。它确实适用于由lazy_static（在本例中为正则表达式）生成的结构，当添加属性时，每个结构的LAZY结构的出现都会消失，但当我尝试将其添加到宏调用上方时，不会发生同样的情况。我原以为它能起作用，但我却得到了一个unused attribute doc.