9

有没有办法从///评论中生成 doc/ 中的单个降价文件?

多个降价文件(doc/main.md,doc/foo.md等)也会很好。

我是 rust 新手,虽然生成的 HTML 文档很好,但我主要生活在命令行上,真的不想为了阅读文档而在终端和 Web 浏览器之间切换。这打破了流程,让我离开了这个区域。此外,md 很容易转换为手册页,或转换为 TeX 以用于打印或 PDF 文档。

(我习惯于使用 Ctrl-Z 或使用另一个终端选项卡来暂停 vim,并运行manorperldocpydoc等。文本模式浏览器像lynxnorlinks对我来说不是很好的选择 - 导航很笨拙,我的 200+ 列上的输出很难看如果我忘记使用该-width选项,终端窗口,并且都不支持 javascript)

4

1 回答 1

2

cargo-readme可能对你有用。你运行cargo readme -i foo.rs > FOO.md它,它用来自 foo.rs 的文档注释的内容填充 FOO.md。通过 reddit找到它。

于 2021-08-22T17:08:24.280 回答