作為一個程序員，肯定希望能寫出一手好代碼，看起來賞心悅目，又易于理解。雖說好的代碼是在一定代碼量的基礎上積累起來的，但在寫代碼之初就應該有意識地去遵循一定的規范。

以下是兩位工程師對于代碼規范的一些總結，很有代表性，分享給大家。+

代碼不是一次性的，要為未來寫代碼

最近的幾件事情讓我對代碼規范的重要性有了更深的體會，決定自己做些總結。
情景一：一個不大的項目，由幾個人共同完成。某日，由于業務需求變更，需要改動我這邊的部分邏輯，但當時我不在，項目組的成員決定由他們來改，但翻了我的代碼，硬是沒找到該邏輯在哪實現的^_^。后來聽了他們的描述，很傷……
情景二：負責一個項目的源代碼流程測試，一期代碼并非模塊化實現，6K多的shell腳本即使有注釋，看著那個頭疼，后來在我們提出該問題后，開發重新進行了設計和規范，拿到代碼的那一刻頓時感覺清晰多了。
都說代碼是程序員的第二張臉，長時間下來，寫的好的代碼定會受到大家的尊重。遵循一些簡單的規范，寫干凈一致的代碼!把個性用在寫出最簡單易懂的代碼上面，而不是晦澀冗余無用的代碼，甚至自我簽名!設計良好的結構和模式，撰寫干凈易懂的代碼，對空間的尊重，對代碼的尊重。這樣能贏得別人的尊重!記住代碼不是一次性的，需要重復的修改和重構，為未來寫點代碼!
1，寫干凈整潔的代碼
1.1 代碼格式化，包括多級代碼縮進、大括號(比如C系代碼)，為了提高代碼的美觀型和易讀性，區間與區間之間最好以一行*或-之類的間距;
1.2 合理運用空行。空行可以用來隔開相對獨立的代碼塊，有利于閱讀和理解。但是不要使用超過一行的空行，對空間，別太奢侈了;
2，命名規范命名包括函數、變量、類(面向對象中)、命名空間等;
2.1命名需要遵循由其命名便知道其意義的原則; 變量命名區分全局變量、導出變量、常量、局部變量，最好區分類型(如果有的話);
2.2 可采用業界的一些命名規范，比如匈牙利命名，但同一個項目必須統一;
3，高效使用注釋
3.1 注釋代碼段，注釋邏輯選擇。上面提到運用空行分割開邏輯相對獨立的代碼，那么請在空行的下一行也寫點下面代碼段要干什么的語句吧。如果有if else等邏輯選擇的時候，麻煩也花幾秒鐘寫上判斷的依據和結果好嗎?邏輯難懂且關鍵，您懂的!
3.2 為不容易理解類變量注釋。類變量特別是私有的類變量沒有人要求注釋，但是為了能夠快速的了解您表示的是什么，還是寫點什么吧!您知道我英文不算好!
3.3 獨立的代碼模塊、文件、函數需要撰寫注釋以說明其實現意圖、原理、怎么使用等(比如函數的輸入輸出參數等)，獨立的代碼文件和模塊(比如類)最好寫上作者、日期、聯系方式、版本號等信息，以便后期做追蹤;
3.4 并不是注釋越多越好，相反，完全模塊化、結構化的程序很多地方注釋完全可以精簡;
4，程序結構化、模塊化
4.1 程序設計中有很多原則、設計模式，不同的語言、不同的情景可能會有些差異，但整體需要支持高類聚、低耦合的設計實現方案;
4.2 養成寫開發文檔的習慣。對于每一個頁面設計(前接頁，后接頁)，包括功能說明，頁面設計，頁面名稱，存放位置等，應當有相應的文檔記載。對于發生改動的地方，需要保留原來的部分(注釋或備份)，并說明備份文件存放的地方，改動時間，修改人;對于程序部分，應該有相應的設計流程，改動的時候，也需要設計改動流程圖，以便以后進行對比，和查找問題所在位置，以及問題的嚴重性分析。
4.3 始終要記住的是你寫出的代碼并不是給你一個人看的，你需要保證你的代碼清晰、一致，別的程序員能夠讀懂，團隊里面最好定期有code review環節。
5，多讀優秀的源代碼、多實踐
5.1 看別人代碼時要汲取好的方法和技巧。
5.2 接觸一項技術要深入了解和實踐，請問您做過的系統您現在都可以從零開始搭建起來了嗎，我的意思是架構搭建哦!（以上部分內容摘自https://blog.csdn.net/bullbat/article/details/9265351，作者：bullbat）

代碼寫多了，總結出適合自己的代碼風格
1、類型的宏替換1）要求要求用“#ifndef”判斷是否之前被定義過。2）舉例

#ifndef GUA_U8

typedef unsigned char GUA_U8;

#endif

#ifndef GUA_U16

typedef unsigned short GUA_U16;

#endif

#ifndef GUA_U32

typedef unsigned long GUA_U32;

#endif

2、宏定義1）要求①宏全為大寫的英文字母。 ②宏的名稱應能讀出其功能作用。2）舉例

#define GUA_RF_COMMUNICATION_JUDGMENT_FALSE 0

#define GUA_RF_COMMUNICATION_JUDGMENT_TRUE 1

3、變量1）要求①變量名稱前的字母含義要求如下 g：global全局。 a：array數組。 s：static靜態。 c：const不變常數。 n：變量。 p：指針。 ②變量的名稱應能讀出其功能作用。2）舉例

GUA_U8 gaGUA_USART1_rx_buf[GUA_USART1_RX_SIZE] = {0};//全局數組

GUA_U8 gnGUA_USART1_rx_buf = 0;//全局變量

GUA_U8 nGUA_USART1_rx_buf = 0;//局部變量

static GUA_U8 snGUA_USART1_rx_buf = 0;//靜態變量

const static GUA_U8 csnGUA_USART1_rx_buf = 0;//const類型的靜態變量

GUA_U8 *gpGUA_USART1_rx_buf; //全局指針

3、if1）要求①“{”與“}”要對齊。 ②if與else的上方要注釋。2）舉例

//如果計數值大于10，則返回true

if(nGUA_Num > 10)

{

return true;

}

//如果計數值小于10，則返回false

else

{

return false;

}

4、switch1）要求①switch、case、default上都要注釋。 ②每種情況的具體處理由“{}”包含。2）舉例

//如果為0則關燈

switch(nbGUA_Char6[3])

{

//關燈

case 0x00:

{

P1_1 = 0; //拉低P11

P1SEL &= ~(1 << 1); //設置P11為IO口

P1DIR |= (1 << 1); //設置P11為輸出

break;

}

//開燈

case 0x01:

{

P1_1 = 1; //拉高P11

P1SEL &= ~(1 << 1); //設置P11為IO口

P1DIR |= (1 << 1); //設置P11為輸出

break;

}

//其它

default:break;

}

5、文件及函數注釋1）文件注釋要求至少要包含文件名稱、文件作用說明、編碼人、最后修改時間。2）函數注釋要求至少要包含函數名稱、函數作用說明、形參含義、返回值含義、編碼人、最后修改時間。