forked from springcute/rt-thread
[pr][template] 增加符合RTThread代码规范条款描述
This commit is contained in:
Meco Man
parent
ce86058201
commit
d05aaa23ab
|
|
@ -27,3 +27,4 @@ As part of this pull request, I've considered the following:
|
|||
- [ ] All modifications to BSP are justified and do not affect other components or BSPs.
|
||||
- [ ] I've commented appropriately where code is tricky.
|
||||
- [ ] Code in this PR is of high quality.
|
||||
- [ ] This PR complies with [RT-Thread code specification](../documentation/coding_style_en.txt)
|
||||
|
|
|
|||
|
|
@ -27,3 +27,4 @@
|
|||
- [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或
|
||||
- [ ] 对难懂代码均提供对应的注释
|
||||
- [ ] 本拉取/合并请求代码是高质量的
|
||||
- [ ] 本拉取/合并符合[RT-Thread代码规范](../documentation/coding_style_cn.md)
|
||||
|
|
|
|||
|
|
@ -27,3 +27,4 @@
|
|||
- [ ] 所有變更均有原因及合理的，並且不會影響到其他軟件組件代碼或
|
||||
- [ ] 對難懂代碼均提供對應的註釋
|
||||
- [ ] 本拉取/合並請求代碼是高質量的
|
||||
- [ ] 本拉取/合並符合[RT-Thread代碼規範](../documentation/coding_style_cn.md)
|
||||
|
|
|
|||
|
|
@ -31,3 +31,4 @@ The following content must not be changed in the submitted PR message. Otherwise
|
|||
- [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
|
||||
- [ ] 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
|
||||
- [ ] 本拉取/合并请求代码是高质量的 Code in this PR is of high quality
|
||||
- [ ] 本拉取/合并符合[RT-Thread代码规范](../documentation/coding_style_cn.md) This PR complies with [RT-Thread code specification](../documentation/coding_style_en.txt)
|
||||
|
|
|
|||
|
|
@ -1,25 +1,18 @@
|
|||
# RT-Thread 编程风格
|
||||
|
||||
这是一份 RT-Thread 开发人员的开发指引。RT-Thread 做为一份开源软件，它需要由不同
|
||||
的人采用合作的方式完成，这份文档是开发人员的一个指引。RT-Thread 的开发人员请遵
|
||||
守这样的编程风格。同时对于使用 RT-Thread 的用户，也可通过这份文档了解 RT-Thread
|
||||
代码内部一些约定从而比较容易的把握到 RT-Thread 的实现方式。
|
||||
这是一份 RT-Thread 开发人员的开发指引。RT-Thread 做为一份开源软件，它需要由不同的人采用合作的方式完成，这份文档是开发人员的一个指引。RT-Thread 的开发人员请遵守这样的编程风格。同时对于使用 RT-Thread 的用户，也可通过这份文档了解 RT-Thread代码内部一些约定从而比较容易的把握到 RT-Thread 的实现方式。
|
||||
|
||||
## 1.目录名称
|
||||
|
||||
目录名称如果无特殊的需求，请使用全小写的形式；目录名称应能够反映部分的意思，例
|
||||
如各芯片移植由其芯片名称构成或芯片类别构成；components 目录下能够反映组件的意义。
|
||||
目录名称如果无特殊的需求，请使用全小写的形式；目录名称应能够反映部分的意思，例如各芯片移植由其芯片名称构成或芯片类别构成；components 目录下能够反映组件的意义。
|
||||
|
||||
## 2.文件名称
|
||||
|
||||
文件名称如果无特殊的需求(如果是引用其他地方，可以保留相应的名称)，请使用全小写
|
||||
的形式。另外为了避免文件名重名的问题，一些地方请尽量不要使用通用化、使用频率高
|
||||
的名称。
|
||||
文件名称如果无特殊的需求(如果是引用其他地方，可以保留相应的名称)，请使用全小写的形式。另外为了避免文件名重名的问题，一些地方请尽量不要使用通用化、使用频率高的名称。
|
||||
|
||||
## 3.头文件定义
|
||||
|
||||
C语言头文件为了避免多次重复包含，需要定义一个符号。这个符号的定义形式请采用如下
|
||||
的风格：
|
||||
C语言头文件为了避免多次重复包含，需要定义一个符号。这个符号的定义形式请采用如下的风格：
|
||||
|
||||
```c
|
||||
#ifndef __FILE_H__
|
||||
|
|
@ -28,8 +21,7 @@ C语言头文件为了避免多次重复包含，需要定义一个符号。这
|
|||
#endif
|
||||
```
|
||||
|
||||
即定义的符号两侧采用 "__" 以避免重名，另外也可以根据文件名中是否包含多个词语而
|
||||
采用 "_" 连接起来。
|
||||
即定义的符号两侧采用 "__" 以避免重名，另外也可以根据文件名中是否包含多个词语而采用 "_" 连接起来。
|
||||
|
||||
## 4.文件头注释
|
||||
|
||||
|
|
@ -62,7 +54,7 @@ C语言头文件为了避免多次重复包含，需要定义一个符号。这
|
|||
};
|
||||
```
|
||||
|
||||
其中，"{"，"}" 独立占用一行，后面的成员定义使用缩进的方式定义。
|
||||
其中，**"{"，"}" 独立占用一行**，后面的成员定义使用缩进的方式定义。
|
||||
|
||||
结构体等的类型定义请以结构体名称加上 "_t" 的形式作为名称，例如：
|
||||
|
||||
|
|
@ -86,9 +78,7 @@ C语言头文件为了避免多次重复包含，需要定义一个符号。这
|
|||
|
||||
## 7.函数名称、声明
|
||||
|
||||
函数名称请使用小写英文的形式，单词之间使用 "_" 连接。提供给上层应用使用的 API
|
||||
接口，必须在相应的头文件中声明；如果函数入口参数是空，必须使用 void 作为入口参
|
||||
数，例如：
|
||||
函数名称请使用小写英文的形式，单词之间使用 "_" 连接。提供给上层应用使用的 API接口，必须在相应的头文件中声明；如果函数入口参数是空，必须使用 void 作为入口参数，例如：
|
||||
|
||||
```c
|
||||
rt_thread_t rt_thread_self(void);
|
||||
|
|
@ -96,18 +86,13 @@ C语言头文件为了避免多次重复包含，需要定义一个符号。这
|
|||
|
||||
## 8.注释编写
|
||||
|
||||
请使用英文做为注释，使用中文注释将意味着在编写代码时需要来回不停的切换中英文输
|
||||
入法从而打断编写代码的思路。并且使用英文注释也能够比较好的与中国以外的技术者进
|
||||
行交流。
|
||||
请使用英文做为注释，使用中文注释将意味着在编写代码时需要来回不停的切换中英文输入法从而打断编写代码的思路。并且使用英文注释也能够比较好的与中国以外的技术者进行交流。
|
||||
|
||||
源代码的注释不应该过多，更多的说明应该是代码做了什么，仅当个别关键点才需要一些
|
||||
相应提示性的注释以解释一段复杂的算法它是如何工作的。对语句的注释只能写在它的上
|
||||
方或右方，其他位置都是非法的。
|
||||
源代码的注释不应该过多，更多的说明应该是代码做了什么，仅当个别关键点才需要一些相应提示性的注释以解释一段复杂的算法它是如何工作的。对语句的注释只能写在它的上方或右方，其他位置都是非法的。
|
||||
|
||||
## 9.缩进及分行
|
||||
|
||||
缩进请采用 4 个空格的方式。如果没有什么特殊意义，请在 "{" 后进行分行，并在下一
|
||||
行都采用缩进的方式，例如：
|
||||
缩进请采用 4 个空格的方式。如果没有什么特殊意义，请在 "{" 后进行分行，并在下一行都采用缩进的方式，例如：
|
||||
|
||||
```c
|
||||
if (condition)
|
||||
|
|
@ -127,9 +112,7 @@ C语言头文件为了避免多次重复包含，需要定义一个符号。这
|
|||
}
|
||||
```
|
||||
|
||||
case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的方式。
|
||||
|
||||
分行上，如果没有什么特殊考虑，请**不要在代码中连续使用两个以上的空行**。
|
||||
case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的方式。分行上，如果没有什么特殊考虑，请**不要在代码中连续使用两个以上的空行**。
|
||||
|
||||
## 10.大括号与空格
|
||||
|
||||
|
|
@ -142,9 +125,7 @@ case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的
|
|||
}
|
||||
```
|
||||
|
||||
匹配的大括号单独占用一行，代码阅读起来就会有相应的层次而不会容易出现混淆的情况。
|
||||
|
||||
空格建议在非函数方式的括号调用前留一个空格以和前面的进行区分，例如：
|
||||
匹配的大括号单独占用一行，代码阅读起来就会有相应的层次而不会容易出现混淆的情况。空格建议在非函数方式的括号调用前留一个空格以和前面的进行区分，例如：
|
||||
|
||||
```c
|
||||
if (x <= y)
|
||||
|
|
@ -158,8 +139,7 @@ case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的
|
|||
}
|
||||
```
|
||||
|
||||
建议在括号前留出一个空格(涉及的包括 if、for、while、switch 语句)，而运算表达式
|
||||
中，运算符与字符串间留一个空格。另外，不要在括号的表达式两侧留空格，例如：
|
||||
建议在括号前留出一个空格(涉及的包括 if、for、while、switch 语句)，而运算表达式中，运算符与字符串间留一个空格。另外，不要在括号的表达式两侧留空格，例如：
|
||||
|
||||
```c
|
||||
if ( x <= y )
|
||||
|
|
@ -172,26 +152,19 @@ case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的
|
|||
|
||||
## 11.trace、log信息
|
||||
|
||||
在 RT-Thread 中，普遍使用的 log 方式是 rt_kprintf。rt_kprintf 在 RT-Thread 被实
|
||||
现成一个采用轮询、非中断方式的字串输出，能够适合于在中断这类"即时"显示日志的场
|
||||
合。因为这种轮询方式的存在，也必然会影响到日志输出的时序关系。
|
||||
在 RT-Thread 中，普遍使用的 log 方式是 rt_kprintf。rt_kprintf 在 RT-Thread 被实现成一个采用轮询、非中断方式的字串输出，能够适合于在中断这类"即时"显示日志的场合。因为这种轮询方式的存在，也必然会影响到日志输出的时序关系。
|
||||
|
||||
建议在代码中不要频繁的使用 rt_kprintf 作为日志输出，除非你真正的明白，你的代码
|
||||
运行占用的时间多一些也没什么关系。
|
||||
建议在代码中不要频繁的使用 rt_kprintf 作为日志输出，除非你真正的明白，你的代码运行占用的时间多一些也没什么关系。
|
||||
|
||||
日志输出应该被设计成正常情况下是关闭状态(例如通过一个变量或宏就能够开启)，并且
|
||||
当真正输出日志时，日志是易懂易定位问题的方式。"天书式"的日志系统是糟糕的，不合
|
||||
理的。
|
||||
日志输出应该被设计成正常情况下是关闭状态(例如通过一个变量或宏就能够开启)，并且当真正输出日志时，日志是易懂易定位问题的方式。"天书式"的日志系统是糟糕的，不合理的。
|
||||
|
||||
## 12.函数
|
||||
|
||||
在内核编程中，函数应该尽量精简，仅完成相对独立的简单功能。函数的实现不应该太长
|
||||
，函数实现太长，应该反思能够如何修改(或拆分)使得函数更为精简、易懂。
|
||||
在内核编程中，函数应该尽量精简，仅完成相对独立的简单功能。函数的实现不应该太长，函数实现太长，应该反思能够如何修改(或拆分)使得函数更为精简、易懂。
|
||||
|
||||
## 13.对象
|
||||
|
||||
RT-Thread 内核采用了 C 语言对象化技术，命名表现形式是：对象名结构体表示类定义、
|
||||
对象名 + 动词短语形式表示类方法，例如：
|
||||
RT-Thread 内核采用了 C 语言对象化技术，命名表现形式是：对象名结构体表示类定义、对象名 + 动词短语形式表示类方法，例如：
|
||||
|
||||
```c
|
||||
struct rt_timer
|
||||
|
|
@ -215,8 +188,7 @@ RT-Thread 内核采用了 C 语言对象化技术，命名表现形式是：对
|
|||
|
||||
rt_timer + 动词短语的形式表示能够应用于 timer 对象的方法。
|
||||
|
||||
在创建一个新的对象时，应该思考好，对象的内存操作处理：是否允许一个静态对象存在
|
||||
，或仅仅支持从堆中动态分配的对象。
|
||||
在创建一个新的对象时，应该思考好，对象的内存操作处理：是否允许一个静态对象存在，或仅仅支持从堆中动态分配的对象。
|
||||
|
||||
## 14. 用 astyle 自动格式化代码
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue