流行的µC/OS代码规范是怎样的？

作者 |strongerHuang

微信公众号 |strongerHuang

• 方便移植
• 一致性
• 整洁
• 维护方便
• 容易理解
• 简单

标头

/**************************************************************************************************                                          Company Name*                                             Address**                         (c) Copyright 19xx, Company Name, City, State*                                       All Rights Reserved*** Filename     :* Programmer(s):* Description  :*************************************************************************************************//*$PAGE*/

包含头文件

/**************************************************************************************************                                        INCLUDE FILES*************************************************************************************************/#include quot;INCLUDES.Hquot;/*$PAGE*/

命名标识符

static  INT16U KeyCharCnt;                  /* Number of keys pressed            */static  char   KeyInBuf[100];               /* Storage buffer to hold chars      */        char   KeyInChar;                   /* Character typed                   */
/*$PAGE*/

• 函数声明中的形式参数应仅包含小写字符。
• 自动变量名称应仅包含小写字符。
• 静态变量和函数应使用文件/模块名称（或其一部分）作为前缀，并应使用大写/小写字符。
• extern变量和函数应使用文件/模块名称（或其一部分）作为前缀，并应使用大写/小写字符。

缩写

注释

int atoi (char *s){    int n;                                  /* Partial result of conversion                   */

    n = 0;                                  /* Initialize result                              */    while (*s >= '0'  *s <= '9'  *s) {  /* For all valid characters and not end of string */        n = 10 * n + *s - '0';              /* Convert char to int and add to partial result  */        s++;                                /* Position on next character to convert          */    }    return (n);                             /* Return the result of the converted string      */}

#define

#define  KEY_FF           0x0F#define  KEY_CR           0x0D#define  KEY_BUF_FULL()  (KeyNRd > 0)

数据类型

typedef  unsigned char  BOOLEAN;            /* Boolean               */typedef  unsigned char  INT8U;              /*  8 bit unsigned       */typedef  char           INT8S;              /*  8 bit signed         */typedef  unsigned int   INT16U;             /* 16 bit unsigned       */typedef  int            INT16S;             /* 16 bit signed         */typedef  unsigned long  INT32U;             /* 32 bit unsigned       */typedef  long           INT32S;             /* 32 bit signed         */typedef  float          FP;                 /* Floating Point        */

局部变量

static  char    KeyBuf[100];static  INT16S  KeyNRd;

缩进

if (x < 0)    z = 25;if (y > 2) {    z = 10;    x = 100;    p++;}

结构体和联合体

typedef struct line {           /* Structure that defines a LINE                 */     int  LineStartX;           /* 'X'  'Y' starting coordinate                 */     int  LineStartY;         int  LineEndX;             /* 'X'  'Y' ending   coordinate                 */     int  LineEndY;           int  LineColor;            /* Color of line to draw                         */} LINE;typedef struct point {          /* Structure that defines a POINT                */    int  PointPosX;             /* 'X'  'Y' coordinate of point                 */    int  PointPosY;    int  PointColor;            /* Color of point                                */} POINT;