有没有办法在 doc/ 中生成单个 markdown 文件///
评论?
多个 Markdown 文件 (doc/main.md
, doc/foo.md
等)也很好。
我是 Rust 新手,虽然生成的 HTML 文档很好,但我主要生活在命令行上,真的不想为了阅读文档而在终端和 Web 浏览器之间切换。这打破了流程,让我脱离了这个区域。此外,md 可以轻松转换为手册页,或转换为 TeX 以用于打印或 PDF 文档。
(我习惯用 Ctrl-Z 暂停 vim 或使用另一个终端选项卡,然后运行man
or perldoc
or pydoc
等文本模式浏览器,例如lynx
nor links
对我来说不是一个好的选择 - 导航很笨拙,如果我忘记使用,我的 200 多个列终端窗口上的输出会很难看-width
选项,都不支持 javascript)
货物自述文件 https://github.com/livioribeiro/cargo-readme可能适合你。你跑cargo readme -i foo.rs > FOO.md
它使用 foo.rs 中的文档注释内容填充 FOO.md。找到了.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)