良好代碼編寫風格可以滿足信、達、雅的要求。在滿足功能和性能目標的前提下，增強代碼的可讀性、可移植性，首要的工作是在項目開發之前為整個設計團隊建立一個命名約定和縮略語清單，以文檔的形式記錄下來，并要求每位設計人員在代碼編寫過程中都要嚴格遵守。良好代碼編寫風格的通則概括如下：
（1） 對所有的信號名、變量名和端口名都用小寫，這樣做是為了和業界的習慣保持一致；對常量名和用戶定義的類型用大寫；
（2） 使用有意義的信號名、端口名、函數名和參數名；
（3） 信號名長度不要太長；
（4） 對于時鐘信號使用clk 作為信號名，如果設計中存在多個時鐘，使用clk 作為時鐘信號的前綴；
（5） 對來自同一驅動源的信號在不同的子模塊中采用相同的名字，這要求在芯片總體設計時就定義好頂層子模塊間連線的名字，端口和連接端口的信號盡可能采用相同的名字；
（6） 對于低電平有效的信號，應該以一個下劃線跟一個小寫字母b 或n 表示。注意在同一個設計中要使用同一個小寫字母表示低電平有效；
（7） 對于復位信號使用rst 作為信號名，如果復位信號是低電平有效，建議使用rst_n；
（8） 當描述多比特總線時，使用一致的定義順序，對于verilog 建議采用bus_signal[x:0]的表示；
（9） 盡量遵循業界已經習慣的一些約定。如*_r 表示寄存器輸出，*_a 表示異步信號，*_pn 表示多周期路徑第n 個周期使用的信號，*_nxt 表示鎖存前的信號，*_z 表示三態信號等；
（10）在源文件、批處理文件的開始應該包含一個文件頭、文件頭一般包含的內容如下例所示：文件名，作者，模塊的實現功能概述和關鍵特性描述，文件創建和修改的記錄，包括修改時間，修改的內容等；
（11）使用適當的注釋來解釋所有的always 進程、函數、端口定義、信號含義、變量含義或信號組、變量組的意義等。注釋應該放在它所注釋的代碼附近，要求簡明扼要，只要足夠說明設計意圖即可，避免過于復雜；
（12）每一行語句獨立成行。盡管VHDL 和Verilog 都允許一行可以寫多個語句，當時每個語句獨立成行可以增加可讀性和可維護性。同時保持每行小于或等于72 個字符，這樣做都是為了提高代碼得可讀性；
（13）建議采用縮進提高續行和嵌套語句得可讀性?？s進一般采用兩個空格，如西安交通大學SOC 設計中心2 如果空格太多則在深層嵌套時限制行長。同時縮進避免使用TAB 鍵，這樣可以避免不同機器TAB 鍵得設置不同限制代碼得可移植能力；
（14）在RTL 源碼的設計中任何元素包括端口、信號、變量、函數、任務、模塊等的命名都不能取Verilog 和VHDL 語言的關鍵字；
（15）在進行模塊的端口申明時，每行只申明一個端口，并建議采用以下順序：
輸入信號的clk、rst、enables other control signals、data and address signals。然后再申明輸出信號的clk、rst、enalbes other control signals、data signals；
（16）在例化模塊時，使用名字相關的顯式映射而不要采用位置相關的映射，這樣可以提高代碼的可讀性和方便debug 連線錯誤；
（17）如果同一段代碼需要重復多次，盡可能使用函數，如果有可能，可以將函數通用化，以使得它可以復用。注意，內部函數的定義一般要添加注釋，這樣可以提高代碼的可讀性；
（18）盡可能使用循環語句和寄存器組來提高源代碼的可讀性，這樣可以有效地減少代碼行數；
（19）對一些重要的always 語句塊定義一個有意義的標號，這樣有助于調試。注意標號名不要與信號名、變量名重復；
（20）代碼編寫時的數據類型只使用IEEE 定義的標準類型，在VHDL 語言中，設計者可以定義新的類型和子類型，但是所有這些都必須基于IEEE 的標準；
（21）在設計中不要直接使用數字，作為例外，可以使用0 和1。建議采用參數定義代替直接的數字。同時，在定義常量時，如果一個常量依賴于另一個常量，建議在定義該常量時用表達式表示出這種關系；
（22）不要在源代碼中使用嵌入式的dc_shell 綜合命令。這是因為其他的綜合工具并不認得這些隱含命令，從而導致錯誤的或較差的綜合結果。即使使用Design Compiler，當綜合策略改變時，嵌入式的綜合命令也不如放到批處理綜合文件中易于維護。這個規則有一個例外的綜合命令，即編譯開關的打開和關閉可以嵌入到代碼中；
（23）在設計中避免實例化具體的門級電路。門級電路可讀性差，且難于理解和維護，如果使用特定工藝的門電路，設計將變得不可移植。如果必須實例化門電路，我們建議采用獨立于工藝庫的門電路，如SYNOPSYS 公司提供的GTECH 庫包含了高質量的常用的門級電路；
（24）避免冗長的邏輯和子表達式；
（25）避免采用內部三態電路，建議用多路選擇電路代替內部三態電路。

總結

以上是生活随笔為你收集整理的良好的代码编写风格（二十五条）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。