是否可以将源代码与Rust中的文档注释分开?

时间:2016-07-23 00:12:43

标签: documentation rust

我喜欢源代码的良好文档,但我讨厌代码中的文档注释。我找到了将代码与其他语言的文档分开的解决方案,但不是Rust。那么,是否有任何解决方案将源代码与Rust中的文档分开?

1 个答案:

答案 0 :(得分:3)

我担心没有。我正在关注Rust生态系统,我甚至从未见过像这样的东西。在相关的说明中,我认为评论应该在代码中,如果你在Rust中编写开源代码,我建议坚持使用标准的做事方式,只为了其他人的利益。例如。我是制表符缩进的生动提倡者,而不是空格(“缩进标签,与空格对齐”),但由于Rust社区定居(明显低于:)空格,我在Rust项目中使用空格。它不符合我的喜好,但在克服它后,它使我和其他人在合作时生活更轻松。

作为一种解决方法,我建议让你的编辑积极地弃用评论。