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

Documentation 是否可以在Rust中将源代码与文档注释分开?,documentation,rust,Documentation,Rust,我喜欢源代码的好文档,但我讨厌代码中的文档注释。我找到了将代码从其他语言的文档中分离出来的解决方案,但没有找到解决方案。那么,有没有办法将源代码与Rust中的文档分开呢?恐怕没有。我关注的是锈菌生态系统,我从来没有见过这样的事。另一方面,我认为注释应该出现在代码中,如果您使用Rust编写开放源代码,我建议您为了其他人的利益,坚持使用标准方法。我是标签缩进而不是空格(“用标签缩进,与空格对齐”)的生动倡导者,但由于Rust社区选择了(明显较低:)空格,我在我的Rust项目中使用空格。这不符合我的喜

我喜欢源代码的好文档,但我讨厌代码中的文档注释。我找到了将代码从其他语言的文档中分离出来的解决方案,但没有找到解决方案。那么,有没有办法将源代码与Rust中的文档分开呢?

恐怕没有。我关注的是锈菌生态系统,我从来没有见过这样的事。另一方面,我认为注释应该出现在代码中,如果您使用Rust编写开放源代码,我建议您为了其他人的利益,坚持使用标准方法。我是标签缩进而不是空格(“用标签缩进,与空格对齐”)的生动倡导者,但由于Rust社区选择了(明显较低:)空格,我在我的Rust项目中使用空格。这不符合我的喜好,但克服它后,我和其他人在合作时会生活得更轻松


作为一种解决办法,我建议让你的编辑积极地折叠评论。

真是太遗憾了!因为我喜欢分离所有的编码元素,比如测试、代码和文档。我不理解用代码编写文档的惯例。对复杂函数的注释是有帮助的,但对文档注释没有帮助。我认为这会让代码无法阅读。不过,非常感谢。@NarabX在其文档附近有文档也有助于保持最新。我可以很容易地想象有人更改了函数的签名,却忘记在文档中更新它。当文档位于函数前2行时,此问题得到缓解。如果您发现文档太多而无法阅读代码,只需将文本编辑器配置为默认情况下折叠文档注释:)@mcarton我理解您的意思,但根据我的经验,即使文档在函数之前,人们也会忽略它;)有时我无法访问我最喜欢的和配置好的文本编辑器。因此,折叠评论是一个很好的解决方法,但这不是我想要的。感谢您的反馈。@NorabX:请注意,Rust有一个特殊的技巧来帮助避免过时的代码样本=>代码样本是在代码的其余部分编译和测试的。有计划让
cargo doc
生成任意的降价,但还没有人能够获得PR。如果您希望文档分开,你不能用一个不生锈的专用工具单独写吗?我可以。你知道一个好的工具吗?有很多好的工具,但它们都是针对个人口味的-这不再是一个生锈的问题了。:-)@如果你想在降价文件中写你的文档,有必要测试它们。