柚子快報(bào)激活碼778899分享：算法 工程代碼開(kāi)發(fā)規(guī)范

http://yzkb.51969.com/

作用

1. 遵循規(guī)范可以寫(xiě)出干凈簡(jiǎn)潔的代碼 2. 可以代碼的質(zhì)量 3. 提升代碼的可讀性 4. 使代碼維護(hù)更加容易

規(guī)范

可讀性和可維護(hù)性

七大原則，空行、空格、成對(duì)書(shū)寫(xiě)、縮進(jìn)、對(duì)齊、代碼行、注釋 縮進(jìn)與空格：規(guī)定代碼的縮進(jìn)方式（空格或制表符Tab）和縮進(jìn)大小，以保持代碼的一致性。 大括號(hào)：規(guī)定大括號(hào)的使用方式，如是否在代碼塊的開(kāi)始處換行。 代碼注釋?zhuān)簭?qiáng)調(diào)代碼注釋的重要性，包括文件描述注釋、函數(shù)注釋和行注釋等，以提高代碼的 目錄結(jié)構(gòu)：規(guī)定項(xiàng)目的目錄結(jié)構(gòu)，如將源代碼、測(cè)試代碼、資源文件等分別放置在不同的目錄下。 模塊劃分：根據(jù)項(xiàng)目需求，將代碼劃分為不同的模塊或組件，以降低代碼耦合度，提高可維護(hù)性。

可維護(hù)性和查錯(cuò)

錯(cuò)誤處理：規(guī)定錯(cuò)誤處理的方式，如使用try-catch語(yǔ)句捕獲異常，并給出明確的錯(cuò)誤信息和處理建議。 代碼復(fù)用：鼓勵(lì)代碼復(fù)用，避免重復(fù)造輪子?？梢酝ㄟ^(guò)定義函數(shù)、類(lèi)庫(kù)或模塊等方式來(lái)實(shí)現(xiàn)代碼復(fù)用。 接口與實(shí)現(xiàn)分離：鼓勵(lì)使用接口和抽象類(lèi)來(lái)定義API，而將具體的實(shí)現(xiàn)細(xì)節(jié)放在實(shí)現(xiàn)類(lèi)中。

性能優(yōu)化：關(guān)注代碼的性能問(wèn)題，如避免不必要的循環(huán)、減少內(nèi)存占用等。同時(shí)，也可以使用一些性能分析工具來(lái)幫助識(shí)別和優(yōu)化性能瓶頸。 代碼審查與測(cè)試 代碼審查：建立代碼審查制度，通過(guò)團(tuán)隊(duì)內(nèi)部或外部的代碼審查來(lái)發(fā)現(xiàn)潛在的問(wèn)題和改進(jìn)點(diǎn)。 單元測(cè)試：編寫(xiě)單元測(cè)試來(lái)驗(yàn)證代碼的正確性和穩(wěn)定性。單元測(cè)試應(yīng)該覆蓋代碼的主要路徑和邊界情況。 集成測(cè)試：進(jìn)行集成測(cè)試以驗(yàn)證不同模塊或組件之間的交互是否正常。

代碼規(guī)范化的七大原則 代碼規(guī)范化基本上有七大原則，體現(xiàn)在空行、空格、成對(duì)書(shū)寫(xiě)、縮進(jìn)、對(duì)齊、代碼行、注釋七方面的書(shū)寫(xiě)規(guī)范上。

空行

空行起著分隔程序段落的作用?？招械皿w將使程序的布局更加清晰?？招胁粫?huì)浪費(fèi)內(nèi)存，雖然打印含有空行的程序會(huì)多消耗一些紙張，但是值得。

規(guī)則一：定義變量后要空行。盡可能在定義變量的同時(shí)初始化該變量，即遵循就近原則。如果變量的引用和定義相隔比較遠(yuǎn)，那么變量的初始化就很容易被忘記。若引用了未被初始化的變量，就會(huì)導(dǎo)致程序出錯(cuò)。

規(guī)則二：每個(gè)函數(shù)定義結(jié)束之后都要加空行。

總規(guī)則：兩個(gè)相對(duì)獨(dú)立的程序塊、變量說(shuō)明之后必須要加空行。比如上面幾行代碼完成的是一個(gè)功能，下面幾行代碼完成的是另一個(gè)功能，那么它們中間就要加空行。這樣看起來(lái)更清晰。

空格

關(guān)鍵字之后要留空格。像 const、case 等關(guān)鍵字之后至少要留一個(gè)空格，否則無(wú)法辨析關(guān)鍵字。像 if、for、while 等關(guān)鍵字之后應(yīng)留一個(gè)空格再跟左括號(hào)(，以突出關(guān)鍵字。 函數(shù)名之后不要留空格，應(yīng)緊跟左括號(hào)(，以與關(guān)鍵字區(qū)別。 ,之后要留空格。如果;不是一行的結(jié)束符號(hào)，其后要留空格。 賦值運(yùn)算符、關(guān)系運(yùn)算符、算術(shù)運(yùn)算符、邏輯運(yùn)算符、位運(yùn)算符，等雙目運(yùn)算符的前后應(yīng)當(dāng)加空格。 注意，運(yùn)算符“%”是求余運(yùn)算符，與 printf 中 %d 的“%”不同，所以 %d 中的“%”前后不用加空格。 單目運(yùn)算符等前后不加空格。 像數(shù)組符號(hào)[]、結(jié)構(gòu)體成員運(yùn)算符.、指向結(jié)構(gòu)體成員運(yùn)算符->，這類(lèi)操作符前后不加空格。 對(duì)于表達(dá)式比較長(zhǎng)的 for 語(yǔ)句和 if 語(yǔ)句，為了緊湊起見(jiàn)，可以適當(dāng)?shù)厝サ粢恍┛崭瘛５?for 和 if 后面緊跟的空格不可以刪，其后面的語(yǔ)句可以根據(jù)語(yǔ)句的長(zhǎng)度適當(dāng)?shù)厝サ粢恍┛崭瘛＠纾?for (i=0; i<10; i++) for 和分號(hào)后面保留空格就可以了，=和<前后的空格可去掉。

縮進(jìn)

縮進(jìn)是通過(guò)鍵盤(pán)上的 Tab 鍵實(shí)現(xiàn)的，縮進(jìn)可以使程序更有層次感。原則是：如果地位相等，則不需要縮進(jìn)；如果屬于某一個(gè)代碼的內(nèi)部代碼就需要縮進(jìn)。

對(duì)齊

對(duì)齊主要是針對(duì)大括號(hào){}說(shuō)的：

{和}分別都要獨(dú)占一行。互為一對(duì)的{和}要位于同一列，并且與引用它們的語(yǔ)句左對(duì)齊。{}之內(nèi)的代碼要向內(nèi)縮進(jìn)一個(gè) Tab，且同一地位的要左對(duì)齊，地位不同的繼續(xù)縮進(jìn)。還有需要注意的是，很多編程軟件是會(huì)“自動(dòng)對(duì)齊”的

#include

int main(void)

{

if (…)

return 0;

}

代碼行

規(guī)則一： 一行代碼只做一件事情，如只定義一個(gè)變量，或只寫(xiě)一條語(yǔ)句。這樣的代碼容易閱讀，并且便于寫(xiě)注釋。

規(guī)則二： if、else、for、while、do 等語(yǔ)句自占一行，執(zhí)行語(yǔ)句不得緊跟其后。此外，非常重要的一點(diǎn)是，不論執(zhí)行語(yǔ)句有多少行，就算只有一行也要加{}，并且遵循對(duì)齊的原則，這樣可以防止書(shū)寫(xiě)失誤。

注釋

C語(yǔ)言中一行注釋一般采用//…，多行注釋必須采用/*…*/。注釋通常用于重要的代碼行或段落提示。在一般情況下，源程序有效注釋量必須在 20% 以上。雖然注釋有助于理解代碼，但注意不可過(guò)多地使用注釋。

規(guī)則一： 注釋是對(duì)代碼的“提示”，而不是文檔。程序中的注釋不可喧賓奪主，注釋太多會(huì)讓人眼花繚亂。

規(guī)則二：如果代碼本來(lái)就是清楚的，則不必加注釋。例如： i++; //i加1 這個(gè)就是多余的注釋。

規(guī)則三： 邊寫(xiě)代碼邊注釋?zhuān)薷拇a的同時(shí)要修改相應(yīng)的注釋?zhuān)员ＷC注釋與代碼的一致性，不再有用的注釋要?jiǎng)h除。 規(guī)則四： 當(dāng)代碼比較長(zhǎng)，特別是有多重嵌套的時(shí)候，應(yīng)當(dāng)在段落的結(jié)束處加注釋?zhuān)@樣便于閱讀。 規(guī)則五： 每一條宏定義的右邊必須要有注釋?zhuān)f(shuō)明其作用。

命名規(guī)范

命名方法

駝峰命名法

名稱(chēng)折疊駝峰法折疊Pascal法別名小駝峰法大駝峰法使用場(chǎng)景命名變量、屬性、方法(函數(shù))命名類(lèi)、空間、常量規(guī)則除第一個(gè)單詞之外，其他單詞首字母大寫(xiě)第一個(gè)單詞的首字母也大寫(xiě)舉例int myCount;Public class DataUser;

蛇形命名法（snake_case） 測(cè)試方法名、常量、枚舉名稱(chēng)需要使用蛇形命名法（snake_case） 各個(gè)單詞之間通過(guò)下劃線“_”連接，比如should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE。

蛇形命名法的優(yōu)勢(shì)是命名所需要的單詞比較多的時(shí)候，

串式命名法（kebab-case） 在串式命名法中，各個(gè)單詞之間通過(guò)連接符“-”連接，比如dubbo-registry。 建議項(xiàng)目文件夾名稱(chēng)使用串式命名法（kebab-case），比如 dubbo 項(xiàng)目的各個(gè)模塊的命名是下面這樣的。

命名規(guī)范

![[Pasted image 20240909204317.png|225]] 標(biāo)識(shí)符命名：標(biāo)識(shí)符（包括變量、函數(shù)、類(lèi)等）的命名應(yīng)做到統(tǒng)一、達(dá)意和簡(jiǎn)潔。 駝峰命名法（camelCase） 下劃線命名法（snake_case），具體取決于公司或項(xiàng)目的約定。 在功能性的命名中盡量避免使用單個(gè)字母，不過(guò)如果在循環(huán)中，可以忽略這一點(diǎn)

//錯(cuò)誤示范

const q = () => {

//....

}

//正確示范

const query = () => {

//....

}//this is also okay

for(let i = 0;i < 10; i++){

//...

}

常量命名：常量通常使用全大寫(xiě)字母和下劃線進(jìn)行命名，以區(qū)別于其他類(lèi)型的標(biāo)識(shí)符。

//正確示范

const DAYS_IN_A_YEAR = 365;

文件命名：文件命名應(yīng)遵循統(tǒng)一的規(guī)則，如使用小寫(xiě)字母、下劃線或連字符分隔單詞，以及避免使用特殊字符。

my_useful_class.cc

my-useful-class.cc

myusefulclass.cc

myusefulclass_test.cc // _unittest 和 _regtest 已棄用.

類(lèi)：大駝峰

函數(shù)/方法：

java

小駝峰 python

小寫(xiě)+下劃線 C++

大駝峰

習(xí)慣

函數(shù)命名 命名盡量注意詳細(xì)， 比如我們需要一個(gè)能夠獲取用戶銀行信息的功能，那么要盡量將命名具體化，如下 錯(cuò)誤的示范：getUserInfo 正確的示范：getUserBankInfo 命名時(shí)注意動(dòng)詞的使用 比如我們需要從數(shù)據(jù)庫(kù)中獲取用戶信息，函數(shù)的名稱(chēng)可以是userInfo，user或者fetchUser，但我推薦使用含有動(dòng)詞的命名 getUser。

//正確示范

function getUser(){

//do something

}

編程語(yǔ)言

C++

作用：C++規(guī)定給標(biāo)識(shí)符（變量、常量）命名時(shí)，有一套自己的規(guī)則

標(biāo)識(shí)符不能是關(guān)鍵字標(biāo)識(shí)符只能由字母、數(shù)字、下劃線組成第一個(gè)字符必須為字母或下劃線標(biāo)識(shí)符中字母區(qū)分大小寫(xiě)

建議：給標(biāo)識(shí)符命名時(shí)，爭(zhēng)取做到見(jiàn)名知意的效果，方便自己和他人的閱讀

類(lèi) 每個(gè)單詞首字母均大寫(xiě), 不包含下劃線: MyExcitingClass, MyExcitingEnum. 函數(shù) 常規(guī)函數(shù)使用大小寫(xiě)混合, 取值和設(shè)值函數(shù)則要求與變量名匹配:

MyExcitingFunction()

MyExcitingMethod()

my_exciting_member_variable()

set_my_exciting_member_variable()

變量

string table_name; // 好 - 用下劃線.

string tablename; // 好 - 全小寫(xiě).

string tableName; // 差 - 混合大小寫(xiě)

其它 類(lèi)成員變量 不管是靜態(tài)的還是非靜態(tài)的, 類(lèi)成員變量都可以和普通變量一樣, 但要接下劃線.

class TableInfo {

...

private:

string table_name_; // 好 - 后加下劃線.

string tablename_; // 好.

static Pool* pool_; // 好.

};

結(jié)構(gòu)體變量 不管是靜態(tài)的還是非靜態(tài)的, 結(jié)構(gòu)體數(shù)據(jù)成員都可以和普通變量一樣, 不用像類(lèi)那樣接下劃線:

struct UrlTableProperties {

string name;

int num_entries;

static Pool* pool;

};

JAVA

類(lèi) 類(lèi)(Class)通常采用名詞進(jìn)行命名，且首字母大寫(xiě)，如果一個(gè)類(lèi)名包含兩個(gè)以上名詞，建議使用駝峰命名(Camel-Case)法書(shū)寫(xiě)類(lèi)名,每個(gè)名詞首字母也應(yīng)該大寫(xiě)。一般地，類(lèi)名的書(shū)寫(xiě)盡量使其保持簡(jiǎn)單和描述的完整性，因此在書(shū)寫(xiě)類(lèi)名時(shí)不建議使用縮寫(xiě)(一些約定俗成的命名除外。 方法 方法(Method)命名時(shí),其首字母應(yīng)該小寫(xiě)，如果方法簽名由多個(gè)單詞組成，則從第二個(gè)單詞起，使用駝峰命名法進(jìn)行書(shū)寫(xiě)。一般地，在對(duì)方法進(jìn)行命名時(shí)，通常采用動(dòng)詞/動(dòng)詞+名詞的組合 變量 變量(Variable)命名包括參數(shù)名稱(chēng)，成員變量和局部變量。變量命名通常以小寫(xiě)字母開(kāi)頭，如果變量名由多個(gè)單詞構(gòu)成，則從第二個(gè)單詞起首字母需要大寫(xiě)，在變量命名過(guò)程中，不建議使用“_”作為前綴或者單詞之間的分割符號(hào)。

類(lèi)名：首字母大寫(xiě)和駝峰原則，如Man、GoodMan方法和變量名：首字母小寫(xiě)和駝峰原則常量：大寫(xiě)字母和下劃線，如MAX_VALUE

Python

…

MySQL

…

開(kāi)發(fā)規(guī)范命名

springboot …

引用文獻(xiàn)

程序員必知–代碼規(guī)范_程序員代碼規(guī)范-CSDN博客 10分鐘搞定令人頭疼的代碼命名規(guī)范 | JavaGuide - 知乎 (zhihu.com) JAVA、C、Python各編程語(yǔ)言命名規(guī)范（最全、持續(xù)補(bǔ)充）_各個(gè)語(yǔ)言的命名規(guī)范-CSDN博客 自學(xué)用，很多引用其他人文章

柚子快報(bào)激活碼778899分享：算法 工程代碼開(kāi)發(fā)規(guī)范

http://yzkb.51969.com/

參考鏈接