1.更新函数编码要求。

This commit is contained in:
MacRsh
2023-11-25 00:27:55 +08:00
parent 93bbe583f7
commit 7817d95608

View File

@@ -93,8 +93,33 @@
...
}
```
2. 函数中功能模块应分块书写,当出现较大块且无法通过代码简单明了的解读时需要标注代码块功能。当返回值无特殊功能时允许紧贴其他代码块,当有其余功能时,需单独成块。
2. 变量命名小写,下划线分隔
```c
void do_something1(int arg1, char arg2)
{
/* do something */
...
/* do something */
...
return OK;
}
void do_something2(int arg1, char arg2)
{
/* do something */
...
/* do something */
...
return /* do something */;
}
```
3. 变量命名小写,下划线分隔
例如:
```c
@@ -102,21 +127,21 @@
char *pointer;
```
3. 宏定义全部大写,下划线分隔。宏函数遵守函数命名规则。
4. 宏定义全部大写,下划线分隔。宏函数遵守函数命名规则。
例如:
```c
#define PI 3.14
```
4. typedef定义使用类型名加`_t`后缀(为使结构体或指针类型特征明显,对于结构体或指针请尽量不使用)。
5. typedef定义使用类型名加`_t`后缀(为使结构体或指针类型特征明显,对于结构体或指针请尽量不使用)。
例如:
```c
typedef unsigned int uint32_t;
```
5. 变量使用时请给出清晰的含义。对于指针当出现不需要写入时,请转换成变量使用。
6. 变量使用时请给出清晰的含义。对于指针当出现不需要写入时,请转换成变量使用。
例如:
```c