一区二区三区三上|欧美在线视频五区|国产午夜无码在线观看视频|亚洲国产裸体网站|无码成年人影视|亚洲AV亚洲AV|成人开心激情五月|欧美性爱内射视频|超碰人人干人人上|一区二区无码三区亚洲人区久久精品

0
  • 聊天消息
  • 系統(tǒng)消息
  • 評(píng)論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線(xiàn)課程
  • 觀看技術(shù)視頻
  • 寫(xiě)文章/發(fā)帖/加入社區(qū)
會(huì)員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識(shí)你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

【筆記】自己用的16種代碼規(guī)范

撞上電子 ? 2023-06-08 10:46 ? 次閱讀
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

1. 命名規(guī)范:

-變量和函數(shù)名應(yīng)使用有意義的名詞或動(dòng)詞短語(yǔ),描述其用途或功能。

inttemperature;//溫度變量voidcalculateAverage();//計(jì)算平均值的函數(shù)

-使用駝峰命名法或下劃線(xiàn)命名法來(lái)命名變量、函數(shù)和常量。

int sensorValue; // 駝峰命名法constintMAX_VALUE=100;//下劃線(xiàn)命名法

-使用大寫(xiě)字母命名宏定義和枚舉常量,并使用下劃線(xiàn)分隔單詞。

#defineBUFFER_SIZE256enumColor{RED,GREEN,BLUE};


2. 縮進(jìn)和格式化:

-使用一致的縮進(jìn)風(fēng)格,通常是四個(gè)空格或一個(gè)制表符。-使用大括號(hào)和適當(dāng)?shù)目s進(jìn)來(lái)組織代碼塊。

if(condition){ // 代碼塊}else{ // 代碼塊}

-適當(dāng)?shù)厥褂每崭駚?lái)提高可讀性,例如在運(yùn)算符、逗號(hào)和分號(hào)之間加入空格。

int sum = a + b;int i, j;for (i = 0; i < n; i++){??//?代碼塊}

-使用空行來(lái)分隔邏輯上相關(guān)的代碼塊,提高代碼的可讀性。

//代碼塊1
// 代碼塊2//代碼塊3


3. 注釋?zhuān)?/p>

-在代碼上方或關(guān)鍵部分添加注釋?zhuān)忉尨a的目的、功能和實(shí)現(xiàn)方法。-使用清晰明確的注釋?zhuān)苊馐褂媚:虿槐匾淖⑨尅?/p>

// 計(jì)算兩個(gè)數(shù)的和int sum(int a, int b){ return a + b;}

4. 函數(shù)和模塊化:

-將代碼劃分為小而獨(dú)立的函數(shù),每個(gè)函數(shù)負(fù)責(zé)完成一個(gè)特定的任務(wù)。-函數(shù)應(yīng)具有單一責(zé)任,只做一件事情,并遵循函數(shù)的輸入輸出原則。

//讀取傳感器值int readSensor(){ // 讀取傳感器代碼 //... return sensorValue;}


5. 錯(cuò)誤處理:

-對(duì)可能出現(xiàn)錯(cuò)誤的代碼塊進(jìn)行錯(cuò)誤檢查,并采取適當(dāng)?shù)腻e(cuò)誤處理措施。-使用返回值、錯(cuò)誤碼或異常處理來(lái)指示和處理錯(cuò)誤情況。

int result = performOperation();if (result != SUCCESS){ // 錯(cuò)誤處理代碼 // ...}

6. 常量和魔法數(shù)值:

-避免在代碼中直接使用魔法數(shù)值(未經(jīng)解釋的硬編碼值),應(yīng)將其定義為常量并使用常量名。

-常量的命名應(yīng)具有描述性和可讀性,以便理解其含義。

const int MAX_SIZE = 100;constfloatPI=3.14159;

7. 函數(shù)參數(shù):

-如果函數(shù)參數(shù)較多,應(yīng)考慮使用結(jié)構(gòu)體或?qū)ο髞?lái)傳遞參數(shù),以減少函數(shù)參數(shù)列表的長(zhǎng)度。-函數(shù)參數(shù)的順序應(yīng)該有邏輯性和一致性,便于閱讀和使用。

voidprocessData(intid,floatvalue,constchar*name)


8. 錯(cuò)誤處理和異常:

-在可能引發(fā)錯(cuò)誤的代碼塊中使用適當(dāng)?shù)腻e(cuò)誤處理機(jī)制,例如返回錯(cuò)誤碼、拋出異?;驁?zhí)行回滾操作。-錯(cuò)誤處理應(yīng)該清晰明確,向調(diào)用者提供足夠的信息以便調(diào)試和修復(fù)錯(cuò)誤。

int result = performOperation();if (result != SUCCESS){ logError("操作執(zhí)行失敗: %d", result); return result;}


9. 可讀性和注釋?zhuān)?/p>

-代碼應(yīng)具有良好的可讀性,使用有意義的變量名和函數(shù)名,并避免使用過(guò)于復(fù)雜的表達(dá)式和嵌套結(jié)構(gòu)。-注釋?xiě)?yīng)該清晰、簡(jiǎn)潔明了,并提供足夠的上下文信息,幫助他人理解代碼的意圖和邏輯。

// 計(jì)算數(shù)組的平均值float calculateAverage(float* data, int size){ float sum = 0; for (int i = 0; i < size; i++) { sum += data[i]; } return sum / size;}


10. 單元測(cè)試和代碼審查:

-編寫(xiě)適當(dāng)?shù)膯卧獪y(cè)試用例來(lái)驗(yàn)證代碼的功能和正確性,確保代碼的健壯性。-進(jìn)行代碼審查,讓其他開(kāi)發(fā)人員檢查代碼的質(zhì)量和遵循規(guī)范的程度,以提供反饋和改進(jìn)建議。
11. 模塊化和函數(shù)長(zhǎng)度:

-將代碼分解為邏輯上獨(dú)立的模塊或函數(shù),每個(gè)函數(shù)應(yīng)該只負(fù)責(zé)一個(gè)具體的任務(wù)或功能。

-函數(shù)應(yīng)保持簡(jiǎn)潔和緊湊,避免過(guò)長(zhǎng)的函數(shù)體和過(guò)多的嵌套層級(jí)。長(zhǎng)函數(shù)可以考慮進(jìn)行重構(gòu)和拆分。

12. 錯(cuò)誤處理和異常:

-在可能引發(fā)錯(cuò)誤的地方進(jìn)行適當(dāng)?shù)腻e(cuò)誤處理和異常處理。捕獲并處理錯(cuò)誤,以避免程序崩潰或無(wú)法預(yù)料的行為。-在發(fā)生錯(cuò)誤時(shí),提供有意義的錯(cuò)誤消息和日志,以便于調(diào)試和故障排除。

13. 持續(xù)集成和自動(dòng)化測(cè)試:

-使用持續(xù)集成工具和自動(dòng)化測(cè)試框架來(lái)驗(yàn)證代碼的正確性和穩(wěn)定性。-設(shè)置自動(dòng)化測(cè)試套件,包括單元測(cè)試、集成測(cè)試和端到端測(cè)試,以捕獲潛在的問(wèn)題和保證代碼質(zhì)量。

14. 版本控制和代碼管理:

-使用版本控制系統(tǒng)(如Git)來(lái)管理代碼的版本和變更歷史。-遵循合適的分支策略,確保不同功能和修復(fù)的代碼可以獨(dú)立開(kāi)發(fā)和集成。-使用合適的注釋和提交信息,清楚記錄每個(gè)版本的變更內(nèi)容和目的。

15. 性能優(yōu)化和資源管理:

-針對(duì)性能敏感的代碼段進(jìn)行優(yōu)化,包括算法改進(jìn)、數(shù)據(jù)結(jié)構(gòu)優(yōu)化等。

-考慮資源的有效管理,包括內(nèi)存分配和釋放、文件句柄的管理等。

16. 編碼標(biāo)準(zhǔn)和風(fēng)格指南:

-遵循特定的編碼標(biāo)準(zhǔn)和風(fēng)格指南,如Google C++ Style Guide、GNU Coding Standards等。

-在團(tuán)隊(duì)中達(dá)成一致,并確保所有開(kāi)發(fā)人員都遵循相同的規(guī)范。

聲明:本文內(nèi)容及配圖由入駐作者撰寫(xiě)或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點(diǎn)僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場(chǎng)。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問(wèn)題,請(qǐng)聯(lián)系本站處理。 舉報(bào)投訴
  • 代碼
    +關(guān)注

    關(guān)注

    30

    文章

    4900

    瀏覽量

    70708
  • 變量
    +關(guān)注

    關(guān)注

    0

    文章

    614

    瀏覽量

    28948
收藏 人收藏
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

    評(píng)論

    相關(guān)推薦
    熱點(diǎn)推薦

    同樣的代碼在官方開(kāi)發(fā)板上運(yùn)行正常,在自己板子上就跑不起來(lái),怎么辦?

    同樣的代碼在Nordic官方開(kāi)發(fā)板上可以運(yùn)行正常,但在自己板子上就跑不起來(lái),如果你碰到了上述情況,建議按照如下步驟進(jìn)行自檢: 首先確認(rèn)用戶(hù)板元器件焊接良好,功能正常。如果你的板子有LED的話(huà),你可以
    的頭像 發(fā)表于 05-12 15:26 ?212次閱讀
    同樣的<b class='flag-5'>代碼</b>在官方開(kāi)發(fā)板上運(yùn)行正常,在<b class='flag-5'>自己</b>板子上就跑不起來(lái),怎么辦?

    如何為micropython添加自己的C代碼庫(kù)?

    部分代碼需要更高效的效率 如何為micropython添加自己的C代碼庫(kù)? 是否有教程? 如果可以的話(huà)是否可以提供一個(gè)實(shí)現(xiàn)實(shí)例?
    發(fā)表于 03-11 07:03

    模電手賬筆記16

    模電手賬筆記16
    的頭像 發(fā)表于 03-03 16:17 ?317次閱讀
    模電手賬<b class='flag-5'>筆記</b>(<b class='flag-5'>16</b>)

    代碼與傳統(tǒng)開(kāi)發(fā)的區(qū)別 低代碼與無(wú)代碼開(kāi)發(fā)的區(qū)別

    在軟件開(kāi)發(fā)領(lǐng)域,傳統(tǒng)開(kāi)發(fā)、低代碼開(kāi)發(fā)以及無(wú)代碼開(kāi)發(fā)是三不同的開(kāi)發(fā)方式,每種方式都有其獨(dú)特的優(yōu)勢(shì)和適用場(chǎng)景。 一、低代碼開(kāi)發(fā)與傳統(tǒng)開(kāi)發(fā)的區(qū)別 低代碼
    的頭像 發(fā)表于 01-31 10:48 ?616次閱讀

    2025款LG gram Pro筆記本首銷(xiāo)

    耐用,還提供泰坦藍(lán)、白色和金屬灰等多種配色。 配置方面,該筆記本可選英特爾酷睿Ultra7 255H/256V處理器。內(nèi)存有16GB或32GB的LPDDR5x可選,搭配1TB的PCIe 4.0 SSD
    的頭像 發(fā)表于 01-23 14:51 ?546次閱讀

    華為支付接入規(guī)范

    空白頁(yè)拉起收銀臺(tái)。 華為支付設(shè)計(jì)規(guī)范 華為支付是一方便、安全和快捷的支付方式。 1.場(chǎng)景介紹 華為支付圖標(biāo)通常在收銀臺(tái)等界面展示,如下圖所示: 圖標(biāo)大小 在核心使用場(chǎng)景下的實(shí)際尺寸通常有 48x48
    發(fā)表于 01-23 09:27

    自己電腦搭建云主機(jī),自己電腦如何搭建云主機(jī)?

    ? 如今,服務(wù)器遠(yuǎn)程連接技術(shù)正逐漸成為行業(yè)的新寵,它代表著服務(wù)器管理領(lǐng)域向高效化、智能化邁進(jìn)的發(fā)展趨勢(shì)。本文將帶你剖析自己電腦如何搭建云主機(jī)。 自己電腦搭建云主機(jī)是一經(jīng)濟(jì)實(shí)惠且具有可行性的選擇
    的頭像 發(fā)表于 01-06 09:55 ?910次閱讀
    <b class='flag-5'>自己</b>電腦搭建云主機(jī),<b class='flag-5'>自己</b>電腦如何搭建云主機(jī)?

    基于 Flexus 云服務(wù)器 X 實(shí)例的應(yīng)用場(chǎng)景 - 私有化部署自己筆記平臺(tái)

    ,為其他人提供一些便利幫助。 一般記錄自己筆記的方式有好多種,比如在開(kāi)源的博客平臺(tái)上發(fā)布,比如 CSDN,博客園,51CTO 博客、公眾號(hào)等。另一方式就是:自己部署一款私有化的
    的頭像 發(fā)表于 01-02 09:55 ?353次閱讀
    基于 Flexus 云服務(wù)器 X 實(shí)例的應(yīng)用場(chǎng)景 - 私有化部署<b class='flag-5'>自己</b>的<b class='flag-5'>筆記</b>平臺(tái)

    Java代碼之美,從遵循樣式規(guī)范開(kāi)始

    至關(guān)重要。本文將帶你探索Java代碼的美學(xué),揭示那些能夠讓你的代碼既美觀又高效的樣式規(guī)范。無(wú)論是初出茅廬的新手還是經(jīng)驗(yàn)豐富的老手,都能從中獲得靈感,提升編碼的藝術(shù)。 一、為什么要代碼
    的頭像 發(fā)表于 11-27 11:42 ?574次閱讀
    Java<b class='flag-5'>代碼</b>之美,從遵循樣式<b class='flag-5'>規(guī)范</b>開(kāi)始

    IEEE 1394物理層晶體的選擇和規(guī)范

    電子發(fā)燒友網(wǎng)站提供《IEEE 1394物理層晶體的選擇和規(guī)范.pdf》資料免費(fèi)下載
    發(fā)表于 09-30 11:03 ?0次下載
    IEEE 1394物理層<b class='flag-5'>用</b>晶體的選擇和<b class='flag-5'>規(guī)范</b>

    怎么樣提高verilog代碼編寫(xiě)水平?

    優(yōu)秀代碼:在網(wǎng)上查找開(kāi)源的、經(jīng)過(guò)驗(yàn)證的高質(zhì)量 Verilog 代碼,學(xué)習(xí)他人的編程風(fēng)格、代碼結(jié)構(gòu)和設(shè)計(jì)思路。 實(shí)踐項(xiàng)目:嘗試自己設(shè)計(jì)和實(shí)現(xiàn)一些較為復(fù)雜的項(xiàng)目,如復(fù)雜的控制器、數(shù)據(jù)處理模
    發(fā)表于 09-25 20:05

    ida反編譯出來(lái)代碼能直接

    IDA反編譯出來(lái)的代碼通常 不能直接使用 ,這主要基于以下幾個(gè)方面的原因: 一、代碼的不完整性 IDA反編譯生成的代碼可能缺少原始源代碼中的某些關(guān)鍵信息。在編譯過(guò)程中,編譯器會(huì)優(yōu)化
    的頭像 發(fā)表于 09-02 10:55 ?1440次閱讀

    16對(duì)語(yǔ)音配線(xiàn)架怎么

    16對(duì)語(yǔ)音配線(xiàn)架的使用主要涉及準(zhǔn)備、安裝、端接、測(cè)試等步驟。以下是一個(gè)詳細(xì)的使用指南: 一、準(zhǔn)備工作 材料準(zhǔn)備: 16對(duì)語(yǔ)音配線(xiàn)架 16對(duì)大對(duì)數(shù)電纜 標(biāo)簽紙 剝線(xiàn)器 打線(xiàn)鉗 壁紙刀 剪刀 尼龍?jiān)鷰?/div>
    的頭像 發(fā)表于 08-21 09:39 ?757次閱讀

    《電動(dòng)自行車(chē)鋰離子蓄電池安全技術(shù)規(guī)范》(GB 43854—2024)

    近日,市場(chǎng)監(jiān)管總局(國(guó)家標(biāo)準(zhǔn)委)發(fā)布《電動(dòng)自行車(chē)鋰離子蓄電池安全技術(shù)規(guī)范》(GB43854—2024,以下簡(jiǎn)稱(chēng)《技術(shù)規(guī)范》)強(qiáng)制性國(guó)家標(biāo)準(zhǔn),該標(biāo)準(zhǔn)由工業(yè)和信息化部歸口,將于2024年11月1日
    的頭像 發(fā)表于 08-14 08:10 ?1520次閱讀
    《電動(dòng)自行車(chē)<b class='flag-5'>用</b>鋰離子蓄電池安全技術(shù)<b class='flag-5'>規(guī)范</b>》(GB 43854—2024)

    在HLS中插入HDL代碼的方式

    很多人都比較反感C/C++開(kāi)發(fā)(HLS)FPGA,大家第一拒絕的理由就是耗費(fèi)資源太多。但是HLS也有自己的優(yōu)點(diǎn),除了快速構(gòu)建算法外,還有一個(gè)就是接口的生成,尤其對(duì)于AXI類(lèi)接口,按照標(biāo)準(zhǔn)語(yǔ)法就可以很方便地生成相關(guān)接口。
    的頭像 發(fā)表于 07-16 18:01 ?1446次閱讀
    一<b class='flag-5'>種</b>在HLS中插入HDL<b class='flag-5'>代碼</b>的方式