|
@@ -57,7 +57,7 @@ fn foo() -> Result<(), SystemError> {
|
|
|
|
|
|
## 3. 注释
|
|
|
|
|
|
-  DragonOS的注释风格与Rust官方的不太一样,我们部分结合了Linux的注释风格。同时,我们推荐您在代码中加入尽可能多的有效注释,以便于其他人理解您的代码。并且,变量、函数等声明,遵守第一节中提到的命名规范,使其能够“自注释”。
|
|
|
+  DragonOS的注释风格与Rust官方的保持一致。同时,我们推荐您在代码中加入尽可能多的有效注释,以便于其他人理解您的代码。并且,变量、函数等声明,遵守第一节中提到的命名规范,使其能够“自注释”。
|
|
|
|
|
|
### 3.1 函数注释
|
|
|
|
|
@@ -72,21 +72,21 @@ fn foo() -> Result<(), SystemError> {
|
|
|
  函数注释的格式如下:
|
|
|
|
|
|
```rust
|
|
|
-/// @brief 函数的功能
|
|
|
+/// # 函数的功能
|
|
|
///
|
|
|
/// 函数的详细描述
|
|
|
///
|
|
|
-/// @param 参数1 参数1的说明
|
|
|
+/// ## 参数
|
|
|
///
|
|
|
-/// @param 参数2 参数2的说明
|
|
|
+/// - 参数1: 参数1的说明
|
|
|
+/// - 参数2: 参数2的说明
|
|
|
+/// - ...
|
|
|
///
|
|
|
-/// @return 返回值的说明
|
|
|
-```
|
|
|
-
|
|
|
-  如果函数的返回值是`Result`类型,那么返回值应当这样进行解释:
|
|
|
-
|
|
|
-```rust
|
|
|
-/// @return Ok(返回值类型) 返回值的说明
|
|
|
+/// ## 返回值
|
|
|
+/// - Ok(返回值类型): 返回值的说明
|
|
|
+/// - Err(错误值类型): 错误的说明
|
|
|
+///
|
|
|
+/// ## Safety
|
|
|
///
|
|
|
-/// @return Err(错误值类型) 错误的说明
|
|
|
+/// 函数的安全性说明
|
|
|
```
|