1. 程式人生 > >第四次作業之代碼規範

第四次作業之代碼規範

釋放 初始化 進行 過程 函數名 實現 在底部 查找 合成

這次作業,由我和李圓圓同學共同完成,結合老師的要求和對資料的查閱,對程序實施有效的約束,讓其方便觀察。


要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格,希望切實可行,容易觀察和客觀檢驗。

排版部分:

  1. 大括號匹配縱列對齊。大括號的對齊使整個程序看起來整潔,把程序分成若幹塊,進行翻閱時易於查找。
  2. 一行最多寫一行語句。清楚易懂,不會造成語句的混亂及誤刪等問題造成不必要的時間浪費。
  3. if,while,do while,for,case等語句獨占一行。
  4. 每個函數有效代碼長度不要超過 60 行。
  5. 循環判斷語句 要用花括號括起(即使只有一個語句),遵循塊的通用規則。
  6. 註釋使用//註釋符,註釋放在語句上方或右方。
  7. 參數之間的逗號後要加一空格。如:method1(int a, int b)
  8. 使用空行分割代碼塊。
  9. 代碼左對齊,函數,類,結構體都采用縮進方式。
  10. include語句放在程序頭部。

命名部分:

  1. 函數名命名通俗易懂,讓人一看就能明白該函數所實現的功能。例如:bool isPra(char c)該函數為判斷是否為括號。
  2. 使用多個單詞組合進行命名時,第一個單詞的首字母小寫,其它單詞的首字母大寫。

其他規範:

  1. 程序在必要的地方必須要有註釋,註釋要簡潔明了。
  2. 進行代碼維護時,要實時更新註釋,避免誤解。
  3. 嚴禁使用未初始化的變量。

要求2 記錄完成本周作業過程中,《代碼風格規範》執行情況。包括記錄每一條規則的違反和糾正、次數,規範中某項條款的增強、消弱、或廢除。在編碼過程中完全未被違反的條款,說明過於寬松,或你們已經完全"本能"反應,不應作為條款,在本要求及要求1中不得分。此種情況,應補充一條新的條款。

記錄一:大括號匹配縱列對齊非常重要,因為在編寫程序的過程中,一不小心就可能丟失括號,這樣的情況不斷發生,所以在編寫過程中,邊寫邊對齊。

記錄二:盡量避免使用do while語句,因為其條件在底部,讀者要瀏覽整個循環體才能明白循環範圍。

記錄三:一行只寫一條語句。在編程過程中,遇到非常短的語句都整合成一行中,以減少代碼的行數,但實際上,代碼不僅不美觀,還容易造成小錯誤。

記錄四:在對程序的後期修改中,有些註釋沒有及時修改,造成邏輯混亂。

第四次作業之代碼規範