最全面的c-c編碼規(guī)范總結(jié)-展示頁
2025-04-16 23:13本頁面
【正文】 頭文件，首先是包含代碼塊，其次是宏定義代碼塊，然后是全局變量，全局常量，類型定義，類定義，內(nèi)聯(lián)部分。不要用無意義的名稱：；；； 頭文件除了特殊情況，應(yīng)使用ifdef控制塊。 系統(tǒng)頭文件應(yīng)用：include 自定義同文件應(yīng)用：include 只引用需要的頭文件。 系統(tǒng)頭文件，穩(wěn)定的目錄結(jié)構(gòu)，應(yīng)采用包含子路徑方式。特殊排版、特殊語法、特殊指令，必須特別說明。對于高質(zhì)量的工程，一般會做到：1. 代碼簡潔精煉，美觀，可讀性好，高效率，高復(fù)用，可移植性好，高內(nèi)聚，低耦合，沒有冗余，不符合這些原則，必須特別說明。 C++編碼規(guī)范，陳世忠，人民郵電出版社，2002 C++ Coding Guidelines GNU Coding Standards等等。最全面的C C++編碼規(guī)范總結(jié)對于不同的編程語言來說，具體的編碼規(guī)范可以有很大的不同，但是其宗旨都是一致的，就是保證代碼在高質(zhì)量完成需求的同時(shí)具備良好的可讀性、可維護(hù)性。例如我們可以規(guī)定某個(gè)項(xiàng)目的C語言程序要遵循這樣的規(guī)定：變量的命名，頭文件的書寫和include下面是一些廣為采用的編碼規(guī)范： Guidelines for the Use of the C Language in Vehicle Based Software SUN Code Conventions for Java以下是一些介紹編碼、編碼規(guī)范的書籍： 高質(zhì)量程序設(shè)計(jì)指南：C++/C語言，林銳等，電子工業(yè)出版社，2003注：以下只是根據(jù)課題組已有的經(jīng)驗(yàn)給出的總結(jié)，并非對所有場景均適用。2. 規(guī)范性，代碼有規(guī)可循。一、文件排版方面 先系統(tǒng)頭文件，后用戶頭文件。 自定義頭文件，不穩(wěn)定目錄結(jié)構(gòu)，應(yīng)在dsp中指定包含路徑。 頭文件命名為*.h，內(nèi)聯(lián)文件命名為*.inl；C++文件命名為*.cpp 文件名用大小寫混合，或者小寫混合。 頭文件endif應(yīng)采用行尾注釋。 CPP文件，包含指令，宏定義，全局變量，函數(shù)定義。 函數(shù)體類體之間原則上用2個(gè)空行，特殊情況下可用一個(gè)或者不需要空行。二、注釋方面 作者，文件名稱，文件說明，生成日期(可選) 關(guān)鍵函數(shù)必須寫上注釋，說明函數(shù)的用途。 除了特別情況，注釋寫在代碼之前，不要放到代碼行之后。 關(guān)鍵代碼注釋，包括但不限于：賦值，函數(shù)調(diào)用，表達(dá)式，分支等等。// TODO ... 調(diào)試的代碼，加上注釋// NOTE ... 對于較大的代碼塊結(jié)尾，如for,while,do等，可加上 標(biāo)識符組成：標(biāo)識符采用英文單詞或其組合，應(yīng)當(dāng)直觀且可以拼讀，可望文知意，用詞應(yīng)當(dāng)準(zhǔn)確，避免用拼音命名。amp。
公司管理相關(guān)推薦
鄂ICP備17016276號-1