好的代码格式,你需要知道这些。自己写的代码。。。代码乱?不想再看?
一些命名规则:
例如在java中,对于C++也适用。
1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下,包的命名规则:将公司域名反转作为包名。比如www.sohu.com对于包名:每个字母都需要小写。比如:com.sohu.test;该包下的Test类的全名是:com.sohu.Test.java。
如果定义类的时候没有使用package,那么java就认为我们所定义的类位于默认包里面(defaultpackage)。
2:类:首字母大写,如果一个类由多个单词构成,那么每个单词的首字母都大写,而且中间不使用任何的连接符。尽量使用英文。如ConnectionFactory
3:方法:首单词全部小写,如果一个方法由多个单词构成,那么从第二个单词开始首字母大写,不使用连接符。addPerson
4:属性:与方法相同。如ageOfPerson
5:常量:所有单词的字母都是大写,如果有多个单词,那么使用下划线链接即可。如:public static final int AGE_OF_PERSON = 20,通常加上static
对于C,自己接触较多,这下面是我常用的命名规则,仿着STM32库总结。
函数命名格式,一般驼峰法:
首字母大写+小写_首字母大写+小写
void Hard_Handler(void)
单个单词不可表述时:
首字母大写+小写+首字母大写+小写_首字母大写+小写
void HardFault_Handler(void);
如果是一些特有的标识:“照样写”,例如:SVC、PendSV等
void SVC_Handler(void);
void PendSV_Handler(void);
void USART1_IRQHandler(void);
文件命名格式,全部小写:
gpio.c
gpio.h
工程文件命名格式:
芯片型号_某公司_实现功能
STM32L431RC_xxx_LCD
枚举:
typedef enum
{
HAL_OK = 0x00,
HAL_ERROR = 0x01,
HAL_BUSY = 0x02,
HAL_TIMEOUT = 0x03
} HAL_StatusTypeDef;
结构体:
typedef struct __I2C_HandleTypeDef
{
I2C_TypeDef *Instance; /*!< I2C registers base address */
I2C_InitTypeDef Init; /*!< I2C communication parameters */
uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
uint16_t XferSize; /*!< I2C transfer size */
} I2C_HandleTypeDef;
typedef struct __I2C_HandleTypeDef与I2C_HandleTypeDef