編碼規範 #職場 #編碼 #休閑

1.1. 程式塊要采用縮進風格編寫，縮進的空格數為3個，縮進與對齊隻使用空格鍵，不應使用Tab鍵。

說明：由開發工具自動生成的代碼縮進格式允許不一緻。

1.2. 函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。

1.3. 在兩個以上的關鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之後或者前後要加空格；進行非對等操作時，如果是關系密切的立即操作符（如－>），後不應加空格。

說明：采用這種松散方式編寫代碼的目的是使代碼更加清晰。

示例：

(1) 逗号、分号隻在後面加空格。

int a, b, c;

(2)比較操作符, 指派操作符"="、 "+="，算術操作符"+"、"%"，邏輯操作符"&&"、"&"，位域操作符"<<"、"^"等雙目操作符的前後加空格。

if (current_time >= MAX_TIME_VALUE)

a = b + c;

a *= 2;

a = b ^ 2;

(3)"!"、"~"、"++"、"--"、"&"（位址運算符）等單目操作符前後不加空格。

*p = 'a'; // 内容操作"*"與内容之間

flag = !isEmpty; // 非操作"!"與内容之間

p = &mem; // 位址操作"&" 與内容之間

i++; // "++","--"與内容之間

(4)"->"、"."前後不加空格。

p->id = pid; // "->"指針前後不加空格

(5) if、for、while、switch等與後面的括号間應加空格，使if等關鍵字更為突出、明顯。

正确寫法：

if (a < 0)

{

return;

}

while(a < 0)

a++;

錯誤寫法：

if (a < 0) return;

a++;

1.4. 一行程式以小于80字元為宜，不要寫得過長。

2.注釋

2.1. 函數頭部應進行注釋，列出：函數的目的/功能、輸入參數、輸出參數、傳回值、調用關系（函數、表）等。

使用Doxygen的JavaDoc style來注釋C++代碼，下面是一個典型class的樣例。詳細可以閱讀doxygen_manual-1.6.3.chm。

/**

* A test class. A more elaborate class description.

class Test

public:

/**

* An enum.

* More detailed enum description.

enum TEnum {

TVal1, /**< enum value TVal1. */

TVal2, /**< enum value TVal2. */

TVal3 /**< enum value TVal3. */

}

*enumPtr, /**< enum pointer. Details. */

enumVar; /**< enum variable. Details. */

/**

* A constructor.

* A more elaborate description of the constructor.

Test();

/**

* A destructor.

* A more elaborate description of the destructor.

~Test();

* a normal member taking two arguments and returning an integer value.

* @param a an integer argument.

* @param s a constant character pointer.

* @see Test()

* @see ~Test()

* @see testMeToo()

* @see publicVar()

* @return The test results

int testMe(int a,const char *s);

* A pure virtual member.

* @see testMe()

* @param c1 the first argument.

* @param c2 the second argument.

virtual void testMeToo(char c1,char c2) = 0;

* a public variable.

* Details.

int publicVar;

* a function variable.

int (*handler)(int a,int b);

};

中間的’*’可以省略：

通常的注釋需包括的資訊

/*************************************************

Function: // 函數名稱

Description: // 函數功能、性能等的描述

Calls: // 被本函數調用的函數清單

Called By: // 調用本函數的函數清單

Table Accessed: // 被通路的表（此項僅對于牽扯到資料庫操作的程式）

Table Updated: // 被修改的表（此項僅對于牽扯到資料庫操作的程式）

Input: // 輸入參數說明，包括每個參數的作

// 用、取值說明及參數間關系。

Output: // 對輸出參數的說明。

Return: // 函數傳回值的說明

Others: // 其它說明

*************************************************/

2.2. 邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一緻性。不再有用的注釋要删除。

2.3. 應盡量避免使用全局變量，如果必須使用全局變量，則全局變量要有較詳細的注釋

2.4. 如果你需要不歸檔的注釋，在Doxygen的注釋/**…*/以外，使用原來的注釋即可：如://…。

3.辨別符命名

3.1. 辨別符的命名要清晰、明了，有明确含義，同時使用完整的單詞或大家基本可以了解的縮寫，避免使人産生誤解，避免使用單個字元作為變量名（如i、j、k，但i、j、k作局部循環變量是允許的）。

說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。

示例：如下單詞的縮寫能夠被大家基本認可。

temp 可縮寫為 tmp ;

flag 可縮寫為 flg ;

statistic 可縮寫為 stat ;

increment 可縮寫為 inc ;

message 可縮寫為 msg ;

3.2. 基本類型字首

類型

字首

例子

int

iVertexNum

bool

bVisible

long

lHandle

byte

byteFlag

char

cInputCharacter

unsigned int

uiStartIndex

short

sMehtodID

usigned short

usIndex

WORD

wIndex

DWORD

dwFlags

3.3. 非基本類型字首

特殊類型

指針類型

pForm

數組類型

aNames

靜态變量

s_manager(此時如果是成員變量可以忽略非公有屬性的下劃線字首規則)

字元串類型字首

std::string std::wstring

str

strName

char*

pstr

pstrName

char[] 數組

szName

結構類型

class/struct

無字首

enum

ePrimitiveType

在别人的基礎上修改而成

編碼規範

繼續閱讀

[好文摘錄] 怎麼樣向老闆提問看上去不蠢？工作中的兩種思維如何通過問問題明确任務職場中有80%的時間花在溝通上，剩下的20%才是你完成任務的時間。學會問問題，是職場溝通中最重要的技能之一。

一秒看透本質的人，是如何思考的？

程式員履歷上寫這種項目，難怪面試當炮灰。。。二、如何讓你的項目經驗更有技術含量

程式員不了解這些投履歷的巨坑，面試注定一開始就失敗！前言第一階段：練手第二階段：沖刺第三階段：收尾

在公司裡寫代碼天天摸魚偷懶，出去面試又該怎麼寫履歷？

iOS開發的幾種加密方式

砺鷹職業測評|更了解自己的職業興趣

測試的基本理論與方法（1）

記一次因MySQL編碼問題導緻的慢查詢排查

java操作access資料庫亂碼問題

面試的三重境界

世界500強常用的管理方法和工具

《程式員的職業素養》四——編碼

V4L2視訊采集與H264編碼1—V4L2采集JPEG資料

一個四年java程式員的年終總結

Netty——自定義協定解決TCP粘包拆包問題什麼是TCP粘包拆包自定義協定解決拆包粘包問題