RT-Thread嵌入式操作系统代码风格指南

RT-Thread嵌入式操作系统代码风格指南

前言

在嵌入式系统开发中，良好的代码风格对于项目的可维护性和团队协作至关重要。RT-Thread作为一款开源嵌入式实时操作系统，其代码风格规范经过多年实践积累，形成了独特的编码标准。本文将详细介绍RT-Thread项目的代码风格要求，帮助开发者编写符合规范的代码。

1. 目录与文件命名规范

1.1 目录命名

RT-Thread要求目录名全部使用小写字母，并采用描述性名称。例如：

• 芯片移植目录：stm32f4xx（芯片型号+芯片类别）
• 组件目录：filesystem（直接描述组件功能）

1.2 文件命名

文件命名同样采用小写字母，避免使用通用名称如common.c等易冲突的名称。特殊情况下可保留原始文件名（如引用第三方库时）。

2. 头文件规范

2.1 多重包含防护

每个头文件必须包含防止多重包含的宏定义，格式如下：

#ifndef __FILE_NAME_H__
#define __FILE_NAME_H__
/* 头文件内容 */
#endif

宏命名采用双下划线开头和结尾，文件名单词间用下划线连接。

2.2 头文件注释

每个头文件顶部必须包含版权信息和变更日志：

/*
 * Copyright (c) 2006-2020, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2006-03-18     Bernard      初始版本
 * 2006-04-26     Bernard      添加信号量API
 */

3. 数据结构定义

3.1 结构体命名

结构体命名采用小写下划线风格：

struct rt_list_node
{
    struct rt_list_node *next;
    struct rt_list_node *prev;
};

• 大括号独占一行
• 成员变量缩进对齐

3.2 类型定义

类型定义在结构体名后加_t：

typedef struct rt_list_node rt_list_t;

内核对象通常定义为指针类型：

typedef struct rt_timer* rt_timer_t;

4. 宏定义规范

宏定义全部使用大写字母，单词间用下划线连接：

#define RT_TRUE 1
#define RT_ASSERT(EXPR) \
    if (!(EXPR)) \
    { \
        /* 断言处理 */ \
    }

5. 函数规范

5.1 函数命名

函数名采用小写下划线风格：

rt_thread_t rt_thread_self(void);

5.2 函数声明

• 提供给上层应用的API必须在头文件中声明
• 无参函数必须显式声明为void

6. 代码格式规范

6.1 缩进规则

• 使用4个空格（推荐）或TAB缩进
• 大括号独占一行

if (condition)
{
    /* 代码块 */
}

6.2 switch语句

case与switch对齐，代码块缩进：

switch (value)
{
case value1:
    /* 处理代码 */
    break;
default:
    break;
}

6.3 空格规则

• 非函数调用的括号前加空格
• 二元/三元运算符两侧加空格
• 括号内不加空格

if (x <= y)  // 正确
if ( x <= y ) // 错误

7. 日志输出规范

RT-Thread使用rt_kprintf进行日志输出，需注意：

1. 这是基于轮询的非中断输出方式
2. 适合中断上下文等"即时"场景
3. 频繁使用会影响系统实时性

建议：

• 默认关闭日志
• 通过宏开关控制日志输出
• 日志信息应简明扼要

8. 函数设计原则

遵循KISS原则（Keep It Simple, Stupid）：

• 函数功能单一
• 避免过长函数（建议不超过50行）
• 复杂逻辑拆分为多个小函数

9. 面向对象实现

RT-Thread在C语言中实现了面向对象编程范式：

• 结构体名称即为对象名
• 对象名+动词短语构成方法名

例如定时器对象：

struct rt_timer
{
    struct rt_object parent;
    /* 其他字段 */
};

/* 定时器方法 */
rt_timer_t rt_timer_create(...);
rt_err_t rt_timer_start(rt_timer_t timer);

10. 内存分配建议

创建对象时需考虑：

1. 优先使用静态对象
2. 必要时才使用堆内存动态分配
3. 权衡分配速度与灵活性

11. 代码格式化工具

推荐使用astyle自动格式化代码，参数配置：

--style=allman
--indent=spaces=4
--indent-preproc-block
--pad-oper
--pad-header
--unpad-paren
--suffix=none
--align-pointer=name
--lineend=linux
--convert-tabs
--verbose

结语

遵循统一的代码风格是保证RT-Thread项目质量的重要基础。本文介绍的规范不仅适用于RT-Thread内核开发，也可作为嵌入式C语言开发的通用参考。良好的编码习惯将显著提高代码的可读性、可维护性和团队协作效率。