资料介绍
軟體編寫時,一些建議編寫的規則~~
目 錄
1 排版
2 注釋
3 識別字命名
4 可讀性
5 變數、結構
6 函數、過程
7 可測性
8 程式效率
9 品質保證
10 代碼編輯、編譯、審查
11 代碼測試、維護
12 宏
1 排版
¹1-1:程式塊要採用縮進風格編寫,縮進的空格數為4個。
說明:對於由開發工具自動生成的代碼可以有不一致。
¹1-2:相對獨立的程式塊之間、變數說明之後必須加空行。
示例:如下例子不符合規範。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
應如下書寫
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-
3:較長的語句(>80字元)要分成多行書寫,長運算式要在低優先順序操作符處劃分新
行,操作符放在新行之首,劃分出的新行要進行適當的縮進,使排版整齊,語句可讀。
示例:
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occ