1. 程式人生 > >軟工作業——團隊作業2.2

軟工作業——團隊作業2.2

修改 數字 停止 也不能 tab 作用域 地方 模塊化設計 tab鍵

代碼規範

一.命名規範

  • 1.每個變量名都按照所起的作用來命名,不隨意命名。例如,分數就用grade來命名而不是a,b,c之類的

  • 2.根據現在通用的命名規則來進行命名變量,常量,函數之類的,方便閱讀

  • 3.不要出現全局變量和局部變量名一樣,會造成誤解,盡管作用域不一樣,但閱讀時可能會造成誤解

  • 4.變量名的長度不要超過20個字符,但也不能太少,能寫全稱就寫全稱,不要寫縮寫,方便閱讀

  • 5.命名時盡量使用英文描述,不要使用拼音中文等其他描述方式

  • 6.如果在不同類或者函數裏面出現相同的變量名,使用下劃線來加上這個變量名的作用範圍,以便閱讀

  • 7.盡量不要使用數字編號,如的確有需要,可以通過下劃線的方式來加編號,例如num_1 這樣,不要num1

二.設計規範

  • 1.采用模塊化設計,通過一個個功能模塊相結合來實現功能,不要把所有實現的功能全部寫在一個模塊裏面

  • 2.每個模塊或者函數裏面,只實現一個所需要的功能,最重要的原則就是:只做一件事,並且做好

  • 3.在設計時,在需要說明的地方或者比較難理解的地方,寫好註釋,方便小組其他成員閱讀

  • 4.在適當的地方進行錯誤處理,使得程序在出現錯誤了可以及時反饋出來且不造成程序停止

  • 5.采用多文件結構,把各個功能模塊可以寫在不同文件裏面,方便修改閱讀等。

三.代碼書寫規範

  • 1.不在一行寫太多東西,盡量一行只執行一個功能,不要執行多個。

  • 2.在縮進時,不要實驗tab鍵,用空格就好,一般是縮進4個空格

  • 3.對於傳過來的參數要進行參數驗證,看是否傳過來的是正確參數

  • 4.對於一個式子裏面出現多個優先級不同的運算符時,用括號括起來說明優先級情況,這樣方便閱讀理解

數據庫設計

ER圖

功能流程描述

小組成員分工

軟工作業——團隊作業2.2