C language programming specification

C Language programming specifications

1. In a source file , The header file contains 、 Macro definition 、 Structure consortium definition 、 Function definitions and so on An area of your own Definition , Don't mix ;

2. The header file contains ：
● If it is an official header ,#include <stdio.h>
● If it is a user header file ：#include “bsp_can.h”
● reason ：< > When compiling, you will first search from the system directory file ," " When compiling, you will first search from the user directory , Speed up compilation

3. Structure consortium definition ：
● Both the structure and the consortium need to use typedef redefinition ;
● Redefined names are capitalized + Underline _ The way , It is similar to the naming of macro definitions , The name of structural weight definition is S_XXX(S Representative structure ), The name of combined weight definition is U_XXX(U On behalf of the Consortium );
● Variables defined in the structure , start 4 A space ( Or click TAB key );
● The opening curly braces own a line , The end curly bracket is followed by the redefined name ;

typedef struct
{
    
 	uint8_t h;
	uint8_t s;
	uint8_t v;
	uint8_t res;
}S_HSV;

4. Variable naming ：
● Naming of small hump , That is, the beginning letter of the first word is lowercase + The following words are capitalized
Such as ：

int armorAreaMax;

● When defining pointer variables ,* Followed by the variable name ;
Such as ：

int *armorAreaMax;

● When defining multiple variables with commas , There should be a blank space after the comma ;
Such as ：

int armorAreaMax, armorAreaMin;

● Try not to use abbreviations , In addition to the Convention commonly known , Such as buf Instead of buffer Yes. ,tmp,rx,tx;
● Cannot use Chinese Pinyin ;

5. Macro definition
● Name in all uppercase and underlined form , It is best to （） Cover up
Such as ：

#define MAX_MUM (5)

6. Function definition
● Function names are in lowercase and underlined form
● In function definition ,（） Multiple local variables defined inside , When using commas , There should be a blank space after the comma

7.if while And so on ：
●if、while You should leave a blank space and add parentheses ;
● The things inside the parentheses should be close to the parentheses , Such as ：

if (a <= 1)
 You can't  if( a <= 1 )

● Curly braces should own a line
●if What's in braces , Empty four or click TAB Key rewriting
● Block and block , Between functions , There is only one blank line
● Function definition even if invisible parameters , Better add void
Such as ：

int swap(void)
{
    

}

attach B Station reference video ：
https://www.bilibili.com/video/BV1Te411474Q?share_source=copy_web