[vhdl+verilog]良好的代碼編寫風(fēng)格(二十五條)

《[vhdl+verilog]良好的代碼編寫風(fēng)格(二十五條)》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、良好代碼編寫風(fēng)格可以滿足信、達(dá)、雅的要求。在滿足功能和性能目標(biāo)的前提下，增強(qiáng)代碼的可讀性、可移植性，首要的工作是在項(xiàng)目開發(fā)之前為整個(gè)設(shè)計(jì)團(tuán)隊(duì)建立一個(gè)命名約定和縮略語清單，以文檔的形式記錄下來，并要求每位設(shè)計(jì)人員在代碼編寫過程中都要嚴(yán)格遵守。良好代碼編寫風(fēng)格的通則概括如下：（1）對(duì)所有的信號(hào)名、變量名和端口名都用小寫，這樣做是為了和業(yè)界的習(xí)慣保持一致；對(duì)常量名和用戶定義的類型用大寫；（2）使用有意義的信號(hào)名、端口名、函數(shù)名和參數(shù)名；（3）信號(hào)名長(zhǎng)度不要太長(zhǎng)；（4）對(duì)于時(shí)鐘信號(hào)使用clk作為信號(hào)名，如果設(shè)計(jì)中存在多個(gè)時(shí)鐘，使用clk作為時(shí)鐘信號(hào)的前綴；（5）對(duì)來

2、自同一驅(qū)動(dòng)源的信號(hào)在不同的子模塊中采用相同的名字，這要求在芯片總體設(shè)計(jì)時(shí)就定義好頂層子模塊間連線的名字，端口和連接端口的信號(hào)盡可能采用相同的名字；（6）對(duì)于低電平有效的信號(hào)，應(yīng)該以一個(gè)下劃線跟一個(gè)小寫字母b或n表示。注意在同一個(gè)設(shè)計(jì)中要使用同一個(gè)小寫字母表示低電平有效；（7）對(duì)于復(fù)位信號(hào)使用rst作為信號(hào)名，如果復(fù)位信號(hào)是低電平有效，建議使用rst_n；（8）當(dāng)描述多比特總線時(shí)，使用一致的定義順序，對(duì)于verilog建議采用bus_signal[x:0]的表示；（9）盡量遵循業(yè)界已經(jīng)習(xí)慣的一些約定。如*_r表示寄存器輸出，*_a表示異步信號(hào)，*_pn表示多周

3、期路徑第n個(gè)周期使用的信號(hào)，*_nxt表示鎖存前的信號(hào)，*_z表示三態(tài)信號(hào)等；（10）在源文件、批處理文件的開始應(yīng)該包含一個(gè)文件頭、文件頭一般包含的內(nèi)容如下例所示：文件名，作者，模塊的實(shí)現(xiàn)功能概述和關(guān)鍵特性描述，文件創(chuàng)建和修改的記錄，包括修改時(shí)間，修改的內(nèi)容等；（11）使用適當(dāng)?shù)淖⑨寔斫忉屗械腶lways進(jìn)程、函數(shù)、端口定義、信號(hào)含義、變量含義或信號(hào)組、變量組的意義等。注釋應(yīng)該放在它所注釋的代碼附近，要求簡(jiǎn)明扼要，只要足夠說明設(shè)計(jì)意圖即可，避免過于復(fù)雜；（12）每一行語句獨(dú)立成行。盡管VHDL和Verilog都允許一行可以寫多個(gè)語句，當(dāng)時(shí)每個(gè)語句獨(dú)立成行可

4、以增加可讀性和可維護(hù)性。同時(shí)保持每行小于或等于72個(gè)字符，這樣做都是為了提高代碼得可讀性；（13）建議采用縮進(jìn)提高續(xù)行和嵌套語句得可讀性?？s進(jìn)一般采用兩個(gè)空格，如西安交通大學(xué)SOC設(shè)計(jì)中心2如果空格太多則在深層嵌套時(shí)限制行長(zhǎng)。同時(shí)縮進(jìn)避免使用TAB鍵，這樣可以避免不同機(jī)器TAB鍵得設(shè)置不同限制代碼得可移植能力；（14）在RTL源碼的設(shè)計(jì)中任何元素包括端口、信號(hào)、變量、函數(shù)、任務(wù)、模塊等的命名都不能取Verilog和VHDL語言的關(guān)鍵字；（15）在進(jìn)行模塊的端口申明時(shí)，每行只申明一個(gè)端口，并建議采用以下順序：輸入信號(hào)的clk、rst、enablesotherc

5、ontrolsignals、dataandaddresssignals。然后再申明輸出信號(hào)的clk、rst、enalbesothercontrolsignals、datasignals；（16）在例化模塊時(shí)，使用名字相關(guān)的顯式映射而不要采用位置相關(guān)的映射，這樣可以提高代碼的可讀性和方便debug連線錯(cuò)誤；（17）如果同一段代碼需要重復(fù)多次，盡可能使用函數(shù)，如果有可能，可以將函數(shù)通用化，以使得它可以復(fù)用。注意，內(nèi)部函數(shù)的定義一般要添加注釋，這樣可以提高代碼的可讀性；（18）盡可能使用循環(huán)語句和寄存器組來提高源代碼的可讀性，這樣可以有效地減少代碼行數(shù)；（19）對(duì)

6、一些重要的always語句塊定義一個(gè)有意義的標(biāo)號(hào)，這樣有助于調(diào)試。注意標(biāo)號(hào)名不要與信號(hào)名、變量名重復(fù)；（20）代碼編寫時(shí)的數(shù)據(jù)類型只使用IEEE定義的標(biāo)準(zhǔn)類型，在VHDL語言中，設(shè)計(jì)者可以定義新的類型和子類型，但是所有這些都必須基于IEEE的標(biāo)準(zhǔn)；（21）在設(shè)計(jì)中不要直接使用數(shù)字，作為例外，可以使用0和1。建議采用參數(shù)定義代替直接的數(shù)字。同時(shí)，在定義常量時(shí)，如果一個(gè)常量依賴于另一個(gè)常量，建議在定義該常量時(shí)用表達(dá)式表示出這種關(guān)系；（22）不要在源代碼中使用嵌入式的dc_shell綜合命令。這是因?yàn)槠渌木C合工具并不認(rèn)得這些隱含命令，從而導(dǎo)致錯(cuò)誤的或較差的綜合結(jié)

7、果。即使使用DesignCompiler，當(dāng)綜合策略改變時(shí)，嵌入式的綜合命令也不如放到批處理綜合文件中易于維護(hù)。這個(gè)規(guī)則有一個(gè)例外的綜合命令，即編譯開關(guān)的打開和關(guān)閉可以嵌入到代碼中；（23）在設(shè)計(jì)中避免實(shí)例化具體的門級(jí)電路。門級(jí)電路可讀性差，且難于理解和維護(hù)，如果使用特定工藝的門電路，設(shè)計(jì)將變得不可移植。如果必須實(shí)例化門電路，我們建議采用獨(dú)立于工藝庫的門電路，如SYNOPSYS公司提供的GTECH庫包含了高質(zhì)量的常用的門級(jí)電路；（24）避免冗長(zhǎng)的邏輯和子表達(dá)式；（25）避免采用內(nèi)部三態(tài)電路，建議用多路選擇電路代替內(nèi)部三態(tài)電路。一.文件命名規(guī)則1:每個(gè)文件中只

8、包含一個(gè)設(shè)計(jì)單元理由:便于修正.規(guī)則2:文件命名協(xié)定