[VHDL+Verilog]良好的代碼編寫風格（二十五條）

良好代碼編寫風格可以滿足信、達、雅的要求。在滿足功能和效能目標的前提下，增強代碼的可讀性、可移植性，首要的工作是在項目開發之前為整個設計團隊建立一個命名規範和縮減語清單，以文檔的形式記錄下來，並要求每位設計人員在代碼編寫過程中都要嚴格遵守。良好代碼編寫風格的通則概括如下：
（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）建議採用縮排提高續行和嵌套語句得可讀性。縮排一般採用兩個空格，如西安交通大學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）在設計中避免執行個體化具體的門級電路。門級電路可讀性差，且難於理解和維護，如果使用特定工藝的門電路，設計將變得不可移植。如果必須執行個體化門電路，我們建議採用獨立於工藝庫的門電路，如SYNOPSY小型股份有限公司提供的GTECH 庫包含了高品質的常用的門級電路；
（24）避免冗長的邏輯和子運算式；
（25）避免採用內部三態電路，建議用多路選擇電路代替內部三態電路。