如何将Rust模块文档保存在单独的Markdown文件中？

Question

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

Answer 1

可以将Rust模块的文档保存在外部.md文件中！但是现在该功能还不稳定，您将需要使用每晚编译器来构建板条箱的文档。

外部文档功能在“不稳定书”的本页中进行了描述，并且在rust-lang / rust＃44732中跟踪了稳定性。

对于外部模块文档，您将使用：

#![feature(external_doc)]

#![doc(include = "my-module-doc.md")]

/* content of the module */

Answer 2

事实并非如此。描述其功能的部分rustdoc是说它可以处理单个.md文件。第三段谈到了这一点：

文档可以通过两种方式生成：从源代码和独立的 Markdown 文件。

据我所知，没有现有的方法可以将代码文档放入外部文件中。理论上可以使用程序派生宏来做到这一点，但我不知道有任何板条箱实际上可以做到这一点。