18-文档属性
3.5.4 文档属性
之前我们提到编写的文档注释会转换成文档属性的形式。除此之外,还有其他文档属性可以用于调整已生成的文档页面,这些属性可以应用在程序库级或元素级,可以写成#[doc(key = value)]这样的形式。一些非常有用的文档属性如下所示。
软件包级属性。
-
![doc(html_logo_url = "image url"):用于在文档页面的左上角添加徽标(logo)。
-
![doc(html_root_url = "https://docs.rs/slotmap/0.2.1")]:用于设置文档页面的统一资源定位器(Uniform Resource Locator,URL)。
-
![doc(html_playground_url = "https://play.rust-lang.org/")]:用于在文档中的代码示例附近放置一个“Run”按钮,以便能够通过在线Rust工作台运行它。
元素级属性。
-
[doc(hidden)]:假定你已经为公共函数foo编写了文档作为自己的注释,但是不希望该函数的使用者查看这些文档,那么可以使用此属性告知rustdoc忽略为foo生成文档。
-
[doc(include)]:用于引用来自其他文件的文档。如果文档很长,这有助于你将文档和代码分开。