代碼為什么需要遵循規(guī)范，來看看μC/OS代碼規(guī)范
素材來源：micrium
編輯整理：strongerHuang
開發(fā)過項(xiàng)目的工程師都知道，一個好的項(xiàng)目，代碼基本都有統(tǒng)一的規(guī)范，否則代碼就會隨著版本迭代，變得越來越臃腫。
代碼規(guī)范應(yīng)在項(xiàng)目早期建立，這些規(guī)范對于保持整個項(xiàng)目的一致性非常有必要，采用一致的規(guī)范可以提高效率并簡化項(xiàng)目維護(hù)。
采用一致的規(guī)范可以：
可移植性
一致性
整潔
維修方便
容易理解
簡單
下面來看看著名的μC/OS代碼的規(guī)范。
/************************************************************************************************** Company Name* Address** (c) Copyright 19xx, Company Name, City, State* All Rights Reserved*** Filename :* Programmer(s):* Description :*************************************************************************************************//*$PAGE*/
/************************************************************************************************** INCLUDE FILES*************************************************************************************************/#include "INCLUDES.H"/*$PAGE*/
三、命名標(biāo)識符
符合ANSI C標(biāo)準(zhǔn)的C編譯器（到目前為止，大多數(shù)C編譯器都這樣做）最多允許32個字符作為標(biāo)識符名稱。標(biāo)識符是變量、結(jié)構(gòu)/聯(lián)合成員、函數(shù)、宏、＃defines等。
比如：大寫字符用于分隔標(biāo)識符中的單詞，功能和下劃線字符（_）類似。
static INT16U KeyCharCnt; /* Number of keys pressed */static char KeyInBuf[100]; /* Storage buffer to hold chars */char KeyInChar; /* Character typed *//*$PAGE*/
μC/OS命名標(biāo)識符：
函數(shù)聲明中的形式參數(shù)應(yīng)僅包含小寫字符。
自動變量名稱應(yīng)僅包含小寫字符。
靜態(tài)變量和函數(shù)應(yīng)使用文件/模塊名稱（或其一部分）作為前綴，并應(yīng)使用大寫/小寫字符。
extern變量和函數(shù)應(yīng)使用文件/模塊名稱（或其一部分）作為前綴，并應(yīng)使用大寫/小寫字符。
| 縮寫 |
原意 |
| Addr | Address |
| Blk | Block |
| Chk | Check |
| Clr | Clear |
| Cnt | Count |
| CPU | Central Processing Unit |
| Ctr | Counter |
| Ctx | Context |
| Cur | Current |
| Del | Delete |
| Dly | Delay |
| Err | Error |
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 */}
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關(guān)鍵字，變量可以按字母順序或功能順序列出。
static char KeyBuf[100];static INT16S KeyNRd;
九、縮進(jìn)
縮進(jìn)有使用空格和Tab兩種符號，規(guī)范通常只使用一種，不能空格和Tab兩種混合使用（現(xiàn)在很多編輯器都支持Tab替換成空格的功能）。
如果混合使用，在不同編輯器打開代碼，你就可能會看到一團(tuán)糟。
μC/OS使用四個空格：
if (x < 0)z = 25;if (y > 2) {z = 10;x = 100;p++;}
十、結(jié)構(gòu)體和聯(lián)合體
包含結(jié)構(gòu)體和聯(lián)合體的格式、命名、注釋等這些都需要規(guī)范，μC/OS代碼使用的比較簡單，也是大眾化的定義：
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;
本文就寫到這里，代碼規(guī)范建議參考一些大廠的規(guī)范手冊。當(dāng)然，每家公司的代碼規(guī)范可能有所不同，只要寫代碼是時(shí)統(tǒng)一就行。
長按前往圖中包含的公眾號關(guān)注
免責(zé)聲明：本文內(nèi)容由21ic獲得授權(quán)后發(fā)布，版權(quán)歸原作者所有，本平臺僅提供信息存儲服務(wù)。文章僅代表作者個人觀點(diǎn)，不代表本平臺立場，如有問題，請聯(lián)系我們，謝謝！
下載文檔
