C++掌握標準編碼規範,摘掉初級“碼農”帽子!

代碼千萬條,可讀第一條。

編碼不規範,error多兩行。

由此可見,編碼規範可謂是各位預備程序員的開學第一課呀。

爲了幫助初學的小夥伴更好地規範自己的代碼,介於之前發了C語言版,今天就整理了一篇C++的編碼規範,

 1、命名規範

關於命名規範我們常用於本地變量名、全局變量名、預處理指令名稱、函數名稱、命名空間名稱、類名、成員變量名稱、成員函數名稱。

1.1 通用命名規範.

在開發的時候命名儘量使用描述性的命名。這樣的命名更加有助於別人快速的理解。比如:

關於縮寫,除非是大家都能夠看得懂的縮寫。否則儘量不要使用縮寫。

1.2 本地變量

通常情況下變量名一律小寫。單詞以下劃線鏈接。如:

1.3 全局變量

對於全局變量的名稱通常可以添加g_作爲前綴。建議儘量少的使用全局變量。全局變量的命名一般不做特殊要求。建議和本地變量的命名規則保持一致。

 

1.4 預處理指令

這裏的預處理指令一般是#defined 這樣的命名定義。一般情況下建議將#defined 後的名稱使用全大寫模式。注意defined之後不要添加語句結束符[;].正常的寫法例如:

1.5 函數

普通函數通常使用大小寫混合模式,函數名以大小寫字母開頭每個單詞的首字母大寫。

例如:

 對於存取函數(get/set)而言建議和成員變量名稱保持一致。例如: 

1.6 命名空間

命名空間的名稱是全小寫的,基於項目名稱和目錄結構如:

1.7 類

類型命名每個單詞以大寫字母開頭,不包含下劃線。例如:

1.8 成員變量

成員變量命名規則和本地變量命名規則保持一致。

1.9 成員函數

成員函數命名規則和全局函數命名規則保持以一致。

 

 2、註釋規範

2.1.單行註釋

使用雙斜線// 或者 /* */ 都可以,一般保持風格同一就好。

2.2.文檔註釋

通常是新建一個.h或者.cpp文件時。添加在文件頂部的註釋。該註釋主要包括。版權、許可版本、作者。

 

2.3.類註釋

類註釋主要描述當前類的作用,以及提供的相關功能。如果在文檔註釋中已經包含相關信息。在類註釋中可以添加一句詳見文檔註釋。

 

2.4.函數註釋

函數聲明:

註釋於聲明之前,描述函數功能及用法,註釋使用描述式("Opens the file")而非指令式 ("Open the file");

註釋只是爲了描述函數而不是告訴函數做什麼。通常,註釋不會描述函數如何實現,那是定義部分的事情。

函數聲明處註釋的內容:

函數定義:

每個函數定義時要以註釋說明函數功能和實現要點,如使用的漂亮代碼、實現的簡要步驟、如此實現的理由、爲什麼前半部分要加鎖而後半部分不需要。

 

2.5. 變量註釋

通常變量名本身足以很好說明變量用途,特定情況下,需要額外註釋說明。

類數據成員:

每個類數據成員(也叫實例變量或成員變量)應註釋說明用途,如果變量可以接受 NULL 或-1等警戒值(sentinel values),須說明。

全局變量:

和數據成員相似,所有全局變量(常量)也應註釋說明含義及用途。

 

 3、編碼規範

3.1. 括號

對於C/C++而言。編碼的中出現的大括號通常放在函數,類等名稱的下一行。例如:

3.2. 縮進

如上一點中代碼展示,在代碼中可以給出適當的縮進。便於代碼的閱讀。

本文主要從命名規範、註釋規範、代碼規範三個方面描述了在日常C++開發過程中需要遵守的規範。

當然正對於不同公司、不同團隊可能會指定自己更加詳細的編碼規範。

在開發過程中小夥伴可以先閱讀一下項目中的其他源代碼,讓自己的代碼風格和項目代碼風格保持一致。


友情提示:良好的編碼規範可以事半功倍喲!

 

對於熱愛編程的人來說,有一羣一起學習一起解答的小夥伴很重要!

這裏有一個C/C++編程學習交流俱樂部,傳送通道:【☯】

還有編程學習文件(源碼,零基礎教程,項目實戰教學視頻),歡迎初學者和正在進階中的小夥伴們!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章