注释和文档
好的代码会说话,好的程序员不写注释,这些都是烂大街的"编程界俚语"。但是,如果你真的遇到一个不写注释的项目或程序员,那一定会对它/他"刮目相看"。
在之前的章节我们学习了包和模块如何使用,在此章节将进一步学习如何书写文档注释,以及如何使用cargo doc生成项目的文档,最后将以一个包、模块和文档的综合性例子,来将这些知识融会贯通。
注释的种类
在Rust中,注释分为三类:
代码注释,用于说明某一块代码的功能,用户往往是同一个项目的协作开发者
文档注释,支持Markdown, 对项目描述、公共