Python基礎:編碼規範(4)

libingql發表於2018-12-22

1.命名規範

  Python中不同程式碼元素採用不同命名方式:

  ◊ 包名:全部小寫字母,中間可以由點分隔開。作為名稱空間,包名需具有唯一性。

  ◊ 模組名:全部小寫字母,如果是多個單詞構成,使用下劃線分隔。

  ◊ 類名:採用Pascal法命名,即每個單詞首字母大寫。如:Student。

  ◊ 異常名:異常屬於類,命名同類命名,但使用Error作為字尾。如:FileNotFoundError。

  ◊ 變數名:全部小寫字母,如果由多個單詞構成,使用下劃線分隔。

         如果變數用於模組或函式內部,則變數名可以由下劃線(_)開頭。

         變數類內部私有變數名可以雙下劃線(__)開頭。

         不要命名雙下劃線開頭和結尾的變數,這是Python保留的。

         避免使用大寫L、大寫O和大寫I作為變數名,不易閱讀分辨。

  ◊ 函式名和方法名:同變數命名。

  ◊ 常量名:全部大寫字母,如果是由多個單詞構成,可以使用下劃線分隔。如YEAR、WEEK_OF_YEAR。

2.註釋規範

2.1 檔案註釋

 

2.2 文件註釋

 

2.3 程式碼註釋

 

2.4 TODO註釋

相關文章