单片机工程编写规范_单片机变量命名规范-程序员宅基地

技术标签: 笔记  c语言  单片机  

如下规范仅限于本人自己做记录和参考,有误之处请大家指正。
变量名:采用小写字母,单词之间用下划线连接。例如:int my_variable;

常量名:全部大写字母,单词之间用下划线连接。例如:#define MAX_VALUE 100;

函数名:采用首字母大写驼峰命名法,单词之间用下划线连接。例如:void MyFunction();

结构体名:采用驼峰命名法,首字母大写。例如:typedef struct MyStruct { … } MyStruct;

枚举名:采用驼峰命名法,首字母大写。例如:enum MyEnum { … };

宏定义名:全部大写字母,单词之间用下划线连接。例如:#define PI 3.1415926;

文件名:全部小写字母,单词之间用下划线连接。例如:my_file.c;

类型定义名:采用驼峰命名法,首字母大写。例如:typedef int MyInt;

成员变量名:采用小写字母,单词之间用下划线连接。例如:struct MyStruct { int my_member_variable; };

局部变量名:采用驼峰命名法,单词之间用下划线连接。例如:int myLocalVariable;
char类型的变量以c为前缀
short类型的变量以s为前缀
long类型的变量以l为前缀
float类型的变量以f为前缀
double类型的变量以d为前缀
enum变量以e为前缀
其他类型(如结构体)以 x 为前缀
point有一个额外的前缀p, 例如short类型的指针前缀为ps
unsigned类型的变量有一个额外的前缀u, 例如无符号short类型的变量前缀为us

本规范将结合工作遇到的情况持续更新。
1.模块化文件格式
(.h)文件

#ifndef __INCLUDE_H
#define __INCLUDE_H

/*************************** Includes ***************************/

/*************************** extern define  ********************/

/*************************** extern variables  *****************/

/*************************** extern function prototypes  *******/

#endif /*__INCLUDE_H*/

(.c)文件

/*
 * @Author: xxxx
 * @Date: xxxx
 * @LastEditors: xxxx
 * @LastEditTime: xxxx
 * @Description: 
 */

/*************************** Includes ***************************/

/*************************** Private define  ********************/

/*************************** Private variables  *****************/

/*************************** Private function prototypes  *******/

/*************************** Public variables  ******************/

/**
  * @brief  main
  * @param  void
  * @retval None.
*/
int main(void)
{
    
    while(1)
    {
    

    }
}

可以定义一个公共的头文件将所有头文件都包含在里面,以后每次写C文件就可以值包含一个头文件。

#ifndef __PUBLIC_H_
#define __PUBLIC_H_

#include "led.h"
#include "pwm.h"
#include "key.h"

#endif /*__PUBLIC_H_*/

2.新定义的类型命名规则
新定义的命名应该明确该对象的含义,尽量使用全部大写,单词之间用下划线进行分割,成员变量使用首字母大写区分各个单词。
枚举加"_e"后缀,结构体加上"_s"后缀,共用体加上"_u"后缀,函数指针加上"_f"后缀

//枚举类型
typedef enum{
    
	MONDAY,
	TUESDAY,
	.....
}WEEK_e;
//结构体类型
typedef struct{
    
	char[10] StudentName;
	int StudentAge;
	....
}STUDENT_s;
//共用体
typedef union{
    
	unsigned char :1;
	unsigned char :7;
	uint8_t xxxx;
}xxx_u;
//函数指针类型
typedef (*usartEvent_Callback_f)(void);

3.命名规则(参考FreeRTOS命名规则)
3.1变量采用前缀+具体用处的形式(下划线+驼峰命名)
u表示无符号
l表示长整型
s表示短整形
c表示字符型
prv表示私有类型
p表示指针变量
x表示重定义类型

匈牙利命名法规则
a Array 数组
b BOOL (int) 布尔(整数)
by Unsigned Char (Byte) 无符号字符(字节)
c Char 字符(字节)
dw DWORD(unsigned long) 双字(无符号长整数)
f Flags 标志(一般是有多位的数值)
fn Function 函数
g global 全局的
p Pointer 指针
m Data member of a class 一个类的数据成员
v void 空
s 字符串型

uint8_t ucUart_SendData;//表示无符号串口发送8位数据
uint16_t usUart_SendData;//表示无符号串口发送16位数据
uint8_t *pucUart_Buff;//表示指向串口缓存的指针
size_t xSize;//表示重定义类型
static uint8_t prvData;//表示私有变量

3.2函数采用具体设备+作用(下划线+驼峰命名)

void Uart_Init(void);//串口初始化
void Uart_SednData(uint8_t Data);//串口发送数据

3.3宏定义命名
尽量采用全部大写的形式,C的宏只能扩展为用大括号括起来的初始化、常量、小括号括起来的表达式、类型限定符、存储类标识符或do-while-zero 结构。

 #define   PI 3.14159F
 #define  CLOCK (XSTAL / 16)
 #define   INIT(value)  {
       (value), 0, 0 } 

如果某一个宏是经常被使用的,则可以使用文件名(小写)+宏名的方式命名

#define configMAX_DELAY	1	//表示在config.h头文件定义

4.在定义函数宏时,每个参数实例都应该以小括号括起来。

 #define  abs (x) ( ( (x) >= 0 ) ? (x) : -(x) )
 #define   READ_TIME_32() \
 do  {
       \
	DISABLE_INTERRUPTS(); \
	time_now = (INT32U) TIMER_HI << 16; \
	time_now = time_now | (INT32U) TIMER_LO; \
	ENABLE_INTERRUPTS(); \
} while(0)   //分号在使用这个宏定义时后面加上

5.使用宏时,不允许参数数值发生变化。

//错误用法
b = SQUARE(a++);           /*结果:a = 7,即执行了两次增。*/

//正确用法
b = SQUARE(a);
a++;                                      /*结果:a = 6,即只执行了一次增*/
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_44711012/article/details/116446486

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk

随便推点

matlab(4):特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析 时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;amp;gt;Jni-&amp;amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法