1. 程式人生 > >《團隊-科學計算器-代碼設計規範》

《團隊-科學計算器-代碼設計規範》

類名 err 全部 存在 約定 ont 混淆 沒有 擴展

代碼布局設計

縮進

  A、 使用四個空格來進行縮進

  B、 換行的時候可以使用反斜杠,最好的方法是使用園括號,在使用反斜杠的時候,在反斜杠的後直接回車,不能有任何空格存在

字符串引導:

  在對於字符串的標示中,使用雙引號還是單引號是沒有區別的,主要就是兩者混合使用從而避免反斜杠的出現。

命名規範:
使用單獨的小寫字母(b)

使用單獨的大寫字母(B)

使用小寫字母(lowercase)

使用小寫字母和下劃線(lower_case_with_underscores)

使用大寫字母(UPPERCASE)

使用大寫字母和下劃線(UPPER_CASE_WITH_UPPERCASE)

駝峰式寫法(CamelCase):在使用縮寫的時候,大寫優於小寫例如HTTPServer優於HttpServer

首字母大寫,然後使用下劃線是一種醜陋的寫法

1 、避免使用的名稱
在寫變量的時候,盡量避免小寫的l和大寫字母O和大寫字母I,主要原因是容易和數字中1,0相混淆

2 、包和模塊名稱
模塊盡量使用簡短的全部小寫的名稱,如果可以增加可讀性那麽可以使用下劃線,python的包不推薦使用下劃線,但是在引用其他語言寫的擴展包中可以使用下劃線來表示區分

3 、類名稱
類名稱主要遵循為CapWords約定,表示為首字母大寫

4、異常名稱

異常歸於類,從而也要遵循類名的規範,主要是在後綴上必須添加“Error“

5全局變量名
全局變量只在模塊類有效,和function命名相同

6、方法名稱
方法名稱全部為小寫,下劃線是可選的(在增加可讀性的基礎上使用)

7、方法變量
類的方法第一個參數總是self

類方法的靜態變量總是為crs

如果一個方法的參數和保留字相沖突,那麽在後面添加下劃線進行區分

8、常量
常量命名全部使用大寫,可以使用下劃線進行分割

註釋

在修改的代碼的時候,務必修改註釋。

註釋必須是英文,最好是完整的句子,首字母大寫

分別為:行註釋,塊註釋,文檔註釋

《團隊-科學計算器-代碼設計規範》