|
|
@ -12,11 +12,11 @@
|
|
|
|
- 文档注释,支持 `Markdown`,对项目描述、公共 API 等用户关心的功能进行介绍,同时还能提供示例代码,目标读者往往是想要了解你项目的人
|
|
|
|
- 文档注释,支持 `Markdown`,对项目描述、公共 API 等用户关心的功能进行介绍,同时还能提供示例代码,目标读者往往是想要了解你项目的人
|
|
|
|
- 包和模块注释,严格来说这也是文档注释中的一种,它主要用于说明当前包和模块的功能,方便用户迅速了解一个项目
|
|
|
|
- 包和模块注释,严格来说这也是文档注释中的一种,它主要用于说明当前包和模块的功能,方便用户迅速了解一个项目
|
|
|
|
|
|
|
|
|
|
|
|
通过这些注释,实现了 Rust 极其优秀的文档化支持,甚至你还能在文档注释中写测试用例,省去了单独写测试用例的环节,我直接好家伙!
|
|
|
|
通过这些注释,实现了 Rust 极其优秀的文档化支持,甚至你还能在文档注释中写测试用例,省去了单独写测试用例的环节,我直呼好家伙!
|
|
|
|
|
|
|
|
|
|
|
|
## 代码注释
|
|
|
|
## 代码注释
|
|
|
|
|
|
|
|
|
|
|
|
显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**,记住,洋洋洒洒那是用来形容文章的,不是形容注释!
|
|
|
|
显然之前的刮目相看是打了引号的,想要去掉引号,该写注释的时候,就老老实实的,不过写时需要遵循八字原则:**围绕目标,言简意赅**;记住,洋洋洒洒那是用来形容文章的,不是形容注释!
|
|
|
|
|
|
|
|
|
|
|
|
代码注释方式有两种:
|
|
|
|
代码注释方式有两种:
|
|
|
|
|
|
|
|
|
|
|
|