DragonOS-Community/DragonOS
1
1
Fork 0
mirror of https://github.com/DragonOS-Community/DragonOS.git synced 2025-06-08 18:26:48 +00:00
Code Issues Releases Wiki Activity

doc: 修改Rust代码注释风格文档 (#471)

Browse Source
This commit is contained in:
LoGin 2023-12-18 17:44:53 +08:00 committed by GitHub
parent 111c5407cc
commit 24ff1faffb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/community/code_contribution/rust-coding-style.md
View File

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