2024年Go最全RT-Thread 编程风格_rtthread代码风格(1)，2024年最新死磕原理

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

即定义的符号两侧采用 “\_\_” 以避免重名，另外也可以根据文件名中是否包含多个词语而采用 “\_” 连接起来。


### 4.文件头注释


在每个源文件文件头上，应该包括相应的版权信息，Change Log 记录：

/*

• Copyright © 2006-2020, RT-Thread Development Team
• SPDX-License-Identifier: Apache-2.0
• Change Logs:
• Date Author Notes
• 2006-03-18 Bernard the first version
• 2006-04-26 Bernard add semaphore APIs
  */

例如采用如上的形式。


### 5.结构体定义


结构体名称请使用小写英文名的形式，单词与单词之间采用 “\_” 连接，例如：

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

其中，**"{"，"}" 独立占用一行**，后面的成员定义使用缩进的方式定义。


结构体等的类型定义请以结构体名称加上 “\_t” 的形式作为名称，例如：

typedef struct rt_list_node rt_list_t;

因为内核中对象引用方便的缘故，采用了对象内核指针作为类型定义的形式，例如：

typedef struct rt_timer* rt_timer_t;

### 6.宏定义


在RT-Thread中，请使用大写英文名称作为宏定义，单词之间使用 “\_” 连接，例如：

#define RT_TRUE                         1

### 7.函数名称、声明


函数名称请使用小写英文的形式，单词之间使用 “\_” 连接。提供给上层应用使用的 API接口，必须在相应的头文件中声明；如果函数入口参数是空，必须使用 void 作为入口参数，例如：

rt_thread_t rt_thread_self(void);

内部静态函数命名：以下划线开头，使用 `_class_method` 格式，不携带`_rt_`开头，如内核或驱动文件中的函数命名：

/* IPC object init */
static rt_err_t _ipc_object_init()

/* UART driver ops */
static rt_err_t _uart_configure()
static rt_err_t _uart_control()

调用注册设备接口的函数命名：使用 `rt_hw_class_init()` 格式，举例：

int rt_hw_uart_init(void)
int rt_hw_spi_init(void)

### 8.注释编写


请使用**英文**做为注释，使用中文注释将意味着在编写代码时需要来回不停的切换中英文输入法从而打断编写代码的思路。并且使用英文注释也能够比较好的与中国以外的技术者进行交流。


**语句注释**：


源代码的注释不应该过多，更多的说明应该是代码做了什么，仅当个别关键点才需要一些相应提示性的注释以解释一段复杂的算法它是如何工作的。对语句的注释只能写在它的**上方或右方**，其他位置都是非法的。

/* 你的英文注释 */

**函数注释**：


注释以 `/**` 开头，以 `*/` 结尾，中间写入函数注释，组成元素如下，每个元素描述之间空一行，且首列对齐：


* @brief + 简述函数作用。在描述中，着重说明该函数的作用，每句话首字母大写，句尾加英文句号。
* @note + 函数说明。在上述简述中未能体现到的函数功能或作用的一些点，可以做解释说明，每句话首字母大写，句尾加英文句号。
* @see + 相关 API 罗列。若有与当前函数相关度较高的 API，可以进行列举。
* @param + 以参数为主语 + be 动词 + 描述，说明参数的意义或来源。
* @return + 枚举返回值 + 返回值的意思，若返回值为数据，则直接介绍数据的功能。
* @warning + 函数使用注意要点。在函数使用时，描述需要注意的事项，如使用环境、使用方式等。每句话首字母大写，句尾加英文句号。


注释模版请参见：rt-thread/src/ipc.c 源码文件，英文注释请参考使用 grammarly 以及谷歌翻译。

/**

• @brief The function will initialize a static event object.
• @note For the static event object, its memory space is allocated by the compiler during compiling,

•       and shall placed on the read-write data segment or on the uninitialized data segment.
  

•       By contrast, the rt_event_create() function will allocate memory space automatically
  

•       and initialize the event.
  

• @see rt_event_create()
• @param event is a pointer to the event to initialize. It is assumed that storage for the event

•       will be allocated in your application.
  

• @param name is a pointer to the name that given to the event.
• @param value is the initial value for the event.

•       If want to share resources, you should initialize the value as the number of available resources.
  

•       If want to signal the occurrence of an event, you should initialize the value as 0.
  

• @param flag is the event flag, which determines the queuing way of how multiple threads wait

•       when the event is not available.
  

•       The event flag can be ONE of the following values:
  

•           RT_IPC_FLAG_PRIO          The pending threads will queue in order of priority.
  

•           RT_IPC_FLAG_FIFO          The pending threads will queue in the first-in-first-out method
  

•                                     (also known as first-come-first-served (FCFS) scheduling strategy).
  

•           NOTE: RT_IPC_FLAG_FIFO is a non-real-time scheduling mode. It is strongly recommended to
  

•           use RT_IPC_FLAG_PRIO to ensure the thread is real-time UNLESS your applications concern about
  

•           the first-in-first-out principle, and you clearly understand that all threads involved in
  

•           this event will become non-real-time threads.
  

• @return Return the operation status. When the return value is RT_EOK, the initialization is successful.

•       If the return value is any other values, it represents the initialization failed.
  

• @warning This function can ONLY be called from threads.
  */
  rt_err_t rt_event_init(rt_event_t event, const char *name, rt_uint8_t flag)
  {
  …
  }

### 9.缩进及分行


缩进请采用 4 个空格的方式。如果没有什么特殊意义，请在 “{” 后进行分行，并在下一行都采用缩进的方式，例如：

if (condition)
{
    /* others */
}

唯一的例外是 switch 语句，switch-case 语句采用 case 语句与 switch 对齐的方式，例如：

switch (value)
{
case value1:
    break;
}

case 语句与前面的 switch 语句对齐，后续的语句则采用缩进的方式。分行上，如果没有什么特殊考虑，请**不要在代码中连续使用两个以上的空行**。


### 10.大括号与空格


从代码阅读角度，建议每个大括号单独占用一行，而不是跟在语句的后面，例如：

if (condition)
{
    /* others */
}

匹配的大括号单独占用一行，代码阅读起来就会有相应的层次而不会容易出现混淆的情况。空格建议在非函数方式的括号调用前留一个空格以和前面的进行区分，例如：

if (x <= y)
{
    /* others */
}

for (index = 0; index < MAX_NUMBER; index ++)
{
    /* others */
}

建议在括号前留出一个空格(涉及的包括 if、for、while、switch 语句)，而运算表达式中，运算符与字符串间留一个空格。另外，不要在括号的表达式两侧留空格，例如：

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

…(img-AJqaPGqy-1715707067998)]
[外链图片转存中…(img-Vm8vTATP-1715707067998)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取