当前位置:嗨网首页>书籍在线阅读

18-文档属性

  
选择背景色: 黄橙 洋红 淡粉 水蓝 草绿 白色 选择字体: 宋体 黑体 微软雅黑 楷体 选择字体大小: 恢复默认

3.5.4 文档属性

之前我们提到编写的文档注释会转换成文档属性的形式。除此之外,还有其他文档属性可以用于调整已生成的文档页面,这些属性可以应用在程序库级或元素级,可以写成#[doc(key = value)]这样的形式。一些非常有用的文档属性如下所示。

软件包级属性。

元素级属性。

  • [doc(hidden)]:假定你已经为公共函数foo编写了文档作为自己的注释,但是不希望该函数的使用者查看这些文档,那么可以使用此属性告知rustdoc忽略为foo生成文档。

  • [doc(include)]:用于引用来自其他文件的文档。如果文档很长,这有助于你将文档和代码分开。