56、【OS】【Nuttx】编码规范解读(四)

news2025/7/17 22:03:26

背景

接之前 blog
53、【OS】【Nuttx】编码规范解读(一)
54、【OS】【Nuttx】编码规范解读(二)
55、【OS】【Nuttx】编码规范解读(三)
分析了行宽格式,注释要求,花括号风格等,下面继续来分析

Nuttx 编码规范

花括号缩进例外

在这里插入图片描述

涉及到结构体(structure)、枚举(enumeration)、联合体(union)时,花括号不需要额外的缩进(对于 GNU 风格而言),举例如下:
在这里插入图片描述
在这里插入图片描述

缩进

在这里插入图片描述

Nuttx 项目中缩进的使用和 GNU 编码规范 类似,但也有点细小的差别

  • 缩进的基本单位是2个空格
  • 每一级的缩进都比前一级多出两个空格
  • 不要使用TAB字符进行缩进,避免不同编辑器对 TAB 宽度解释不一致(如果使用,记得把编辑器的缩进调成 两个空格)

举例如下:
在这里插入图片描述

Tab 使用说明

在这里插入图片描述
虽然源文件和头文件禁止使用 TAB 进行缩进,但在如Makefile、汇编语言源文件、Kconfig文件和一些脚本文件中,允许使用 TAB 进行缩进,TAB 设置为 4 个空格

花括号对齐

在这里插入图片描述
花括号必须单独占一行,每级需要缩进两个空格,而且花括号本身也要缩进两个空格(GNU风格),这里就有个有趣的现象:

  • 所有C语句所在列为 4*n + 2(比如 2, 6, 10…)
  • 左右花括号所在列为 4*n(比如 4, 8, 12…)
  • 上述特性意味着在同一缩进级别,代码行和对应的左右花括号在不同的固定列上对齐

预处理指令的缩进

在这里插入图片描述

  • 预处理器指令的关键字(#)从第 1 列开始
  • 预处理器指令也要遵循一般的缩进规则(即每级缩进2个空格),从关键字(#)后面的内容开始遵循这个缩进原则

举例如下
在这里插入图片描述
例外:每个头文件在开头包含了幂等性定义,这种条件编译不会引起任何缩进的变化,举例如下
在这里插入图片描述

圆括号

在这里插入图片描述
圆括号需遵循以下规则:

  • 关键字后留空格:使用C语言关键字(如 if, for, switch, while, do, return 等)时,不要将左括号(直接跟在关键字后面,关键字和左括号之间要有一个空格
  • 函数名与参数列表之间不要有空格
  • 右括号前不要加空格
  • 返回值不要加括号,除非是为了强制运算顺序

示例如下:
在这里插入图片描述
Nuttx 对圆括号的态度:
在这里插入图片描述

  • 有些开发人员对运算符优先级不太有把握,因此喜欢在表达式中大量圆括号来明确指定运算顺序,而这些括号实际上不会影响运算顺序
  • 虽然这样可以防止误解运算符优先级,但也让代码看起来很丑

基于以上考虑,Nuttx 不推荐为了强制运算顺序而使用不必要的括号,但也没有特定要求必须或禁止使用括号,而是建议开发人员实事求是,视具体情况来决定是否使用括号

数据和类型定义

定义和声明独占一行

示例如下
在这里插入图片描述

全局变量

在这里插入图片描述

  • 全局变量是在函数外定义的变量,作用域可以跨越多个文件或仅限于单个文件
  • 全局符号前如果加上 static 关键字,则该变量的作用域仅限于定义它的文件,也就是私有全局符号
  • 没有 static 修饰符的全局变量可以在不同的文件间共享,这类符号被称为公共全局变量

编码规范:

  • 名字要简短,避免过于冗长的变量名,比如 g_filelen 就比 g_lengthoffile 要好
  • 全局变量名要以前缀 g_ 开头,以指示其为全局变量
  • 如果全局变量属于某个特定模块,要在前缀中包含该模块名,比如 xyz 模块的全局变量格式为g_xyz
  • 全局变量名全部使用小写字母(不用驼峰写法)
  • 尽量避免在变量名中使用下划线作为分隔符,以减少下划线的使用
  • 对于较长的变量名可能需要下划线分割来提高可读性,但总体上变量名还是要简短
  • 尽量把全局变量封装在结构体内,以减少命名冲突
  • 限制全局变量的使用,能用私有的就用私有,对外暴露用接口形式,面向接口编程

举例如下:
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2362781.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

IOT项目——DIY 气象站

开源项目:ESP32 气象站 作者:GiovanniAggiustatutto 原文链接:原文 开源项目:太阳能 WiFi 气象站 V4.0 作者:opengreenenergy 原文链接:原文 DIY 气象站 简介1-制版2-物料 温度设备塔风向标风速计雨量计框…

MODSIM选型指南:汽车与航空航天企业如何选择仿真平台

1. 引言 在竞争激烈的汽车与航空航天领域,仿真技术已成为产品研发不可或缺的环节。通过在设计阶段验证概念并优化性能,仿真平台能有效缩短开发周期并降低物理样机制作成本。 MODSIM(建模与仿真)作为达索系统3DEXPERIENCE平台的核…

【JavaEE】springMVC返回Http响应

目录 一、返回页面二、Controller和ResponseBody与RestController区别三、返回HTML代码⽚段四、返回JSON五、HttpServletResponse设置状态码六、设置Header6.1 HttpServletResponse设置6.2 RequestMapping设置 一、返回页面 步骤如下: 我们先要在static目录下创建…

计算机网络八股文--day4 --传输层TCP与UDP

这是面试中最常考到的一层:端到端(也就是进程之间)的透明数据传输服务,差错控制和流量控制 该层呈上启下,像上面的资源子网提高服务,并使用下面通信子网的服务 端口,用于唯一标识主机上进程的&…

个人开发免费好用

聊一聊 现在输入法非常多,有时候都不知道哪个更好用。 其实,只有多尝试,才能找到适合自己的。 今天给大家分享一款输入法,用起来比较顺手,大家可以试试。 软件介绍 BL输入法 这是一款绿色纯净,安全放心…

[随笔] 升级uniapp旧项目的vue、pinia、vite、dcloudio依赖包等

汇总 # 升级uniapp项目dcloudio整体依赖,建议执行多次 # 会顺带自动更新/升级vue的版本 npx dcloudio/uvmlatest alpha# 检查 pinia 的最新版本 npm view pinia version# 更新项目 pinia 到最新版本 npm update pinia# 更新项目 pinia 到特定的版本 # 首先&#xf…

第十六届蓝桥杯 2025 C/C++组 密密摆放

目录 题目: 题目描述: 题目链接: 思路: 思路详解: 发个牢骚: 代码: 代码详解: 题目: 题目描述: 题目链接: P12337 [蓝桥杯 2025 省 AB/Python B 第二…

【QT】QT中的网络编程(TCP 和 UDP通信)

QT中的网络编程(TCP 和 UDP通信) 1.tcp1.1 tcp通信1.1.1 相比linux中tcp通信:1.1.2 QT中的tcp通信: 1.2 tcp通信流程1.2.1 服务器流程:1.2.1.1 示例代码1.2.1.2 现象 1.2.2 客户端流程:1.2.2.1 示例代码1.2.2.2 现象: …

第38课 常用快捷操作——双击“鼠标左键”进入Properties Panel

概述 在设计过程中,我们经常需要更改某个图元的属性,例如更该焊盘的大小、更改网络的名称等等。 在AD 20中,更改属性一般都是在Properties Panel上完成的。 当我们要更改某个图元的属性时,我们用鼠标左键双击它,就可…

从零开发一个B站视频数据统计Chrome插件

从零开发一个B站视频数据统计Chrome插件 前言 B站(哔哩哔哩)作为国内最大的弹幕视频网站之一,视频的播放量、点赞、投币、收藏等数据对于内容创作者和数据分析者来说非常重要。本文将带你一步步实现一个Chrome插件,自动统计并展…

[stm32] 4-1 USART(1)

文章目录 前言4-2 USART与串口通信(1)USART简介什么是USART?USART名字的含义?如何使用USART? USART的工作原理什么是串并转换?为什么要进行串并转换?移位寄存器串并行转换电路 USART寄存器组和完整框图 前言 本笔记内容&#xff…

记录两个免费开源又好用的后台模版vue3

一.element-plus-admin 一套基于vue3、element-plus、typesScript、vite的后台集成方案 1.简介 vue-element-plus-admin 是一个基于 element-plus 免费开源的中后台模版。使用了最新的 Vue3,Vite,Typescript等主流技术开发,开箱即用的中后…

【AI生产力工具】Windsurf,一款AI编程工具

Windsurf 是 Codeium 公司推出的一款 AI 编程助手,它是一款集成深度上下文感知、多模型协作和实时代码管理的综合开发环境(IDE)。 Windsurf 作为 AI 编程工具的核心价值在于 “上下文感知 + 多模型协作 + 自动化工作流”,其深度集成的智能体系统(如 Flows 和 Cascade)正…

Mybatisplus:一些常用功能

自动驼峰 mybatis-plus:configuration:# 开启驼峰命名规则,默认true开启map-underscore-to-camel-case: true# 控制台日志打印,便于查看SQLlog-impl: org.apache.ibatis.logging.stdout.StdOutImpl TableName 作用:表名注解,标识…

batch normalization和layer normalization区别

Normalization无非就是这样一个操作: 其中x是输入数据,维度为(B,T,C),其中B是batchsize,T是序列长度,C是embedding维度;括号内是标准化操作,γ和…

【多线程】七、POSIX信号量 环形队列的生产者消费者模型

文章目录 Ⅰ. 信号量一、POSIX 信号量的概念二、POSIX 信号量的类型区别三、POSIX 信号量与 SystemV 信号量的区别Ⅱ. 线程信号量基本原理一、为什么要引入信号量❓二、PV 操作三、POSIX 信号量的实现原理四、CAS操作介绍Ⅲ. POSIX未命名信号量接口一、初始化无名信号量二、销毁…

JVM 一文详解

目录 JVM 简介 JVM 中的内存区域划分 1. 堆(一个进程只有一份 ------ 线程共享) 2. 栈(一个进程可以有 N 份 ------ 线程私有) Java 虚拟机栈: 本机方法栈: 3. 程序计数器(一个线程可以…

代码随想录算法训练营第60期第二十二天打卡

大家好!我们今天来到了一个全新的章节,回溯算法,那究竟什么是回溯算法,我们应该如何理解回溯算法,以及回溯算法可以解决的题目,我们今天就来一探究竟。 第一部分 回溯算法理论基础 其实我可以告诉大家的是…

自主机器人模拟系统

一、系统概述 本代码实现了一个基于Pygame的2D自主机器人模拟系统,具备以下核心功能: 双模式控制:支持手动控制(WASD键)和自动导航模式(鼠标左键设定目标) 智能路径规划:采用改进型…

基于QT的仿QQ音乐播放器

一、项目介绍 该项目是基于QT开发的⾳乐播放软件,界面友好,功能丰富,主要功能如下: 窗口hand部分: 点击最小化按钮,窗口最小化 点击最大化按钮,窗口最大化 点击关闭按钮,程序退出 …