編程風格（Coding Style）要求

編程風格（Coding Style）要求
2.1.1 文件
（1） 每一個模塊（module）通常應存在於單獨的源文件中，一般源文件名與所包含模塊名相同。
（2） 每一個設計文件開頭應包含以下注釋內容：
? 年份及公司名稱。
? 做者。
? 文件名。
? 所屬項目。
? 頂層模塊。
? 模塊名稱及其描述。
? 修改紀錄。
2.1.2 大小寫
（1） 如無特別須要，模塊名和信號名一概採用小寫字母。
（2） 爲醒目起見，常數（`define定義）/參數（parameter定義）採用大寫字母。
2.1.3 標識符
（1） 標識符采用傳統C語言的命名方法，即在單詞之間以「_」分開，如：max_delay、data_size等等。
（2） 採用有意義的、能反映對象特徵、做用和性質的單詞命名標識符，以加強程序的可讀性。
（3） 爲避免標識符過於冗長，對較長單詞的應當採用適當的縮寫形式，如用‘buff’代替‘buffer’，‘ena’代替‘enable’，‘addr’代替‘address’等。
2.1.4 參數化設計
爲了源代碼的可讀性和可移植性起見，不要在程序中直接寫特定數值，儘量採用`define語句或paramater語句定義常數或參數。
2.1.5 空行和空格
（1） 適當地在代碼的不一樣部分中插入空行，避免因程序擁擠不利閱讀。
（2） 在表達式中插入空格，避免代碼擁擠，包括：
賦值符號兩邊要有空格；
雙目運算符兩邊要有空格；
單目運算符和操做數之間可沒有空格，
示例以下：
a <= b;
c <= a + b;
if (a == b) then ...
a <= ~a & c;
2.1.6 對齊和縮進
（1） 不要使用連續的空格來進行語句的對齊。
（2） 採用製表符Tab對語句對齊和縮進，Tab鍵採用4個字符寬度，可在編輯器中設置。
（3） 各類嵌套語句尤爲是if...else語句，必須嚴格的逐層縮進對齊。
2.1.7 註釋
必須加入詳細、清晰的註釋行以加強代碼的可讀性和可移植性，註釋內容佔代碼篇幅不該少於30%。