1.代碼樣式規范
1.行縮進:tap鍵(4個空格)
1.對齊縮進
2.層級縮進 (縮進8個空格,比函數體再縮進一個tab)
3.\ 換行符,行連接
2.單行最大字符限制
1.所有行限制最大字符數為79
2.沒有結構化限制的大塊文本(文檔字符或者注釋),每行的最大字符數限制在72
3.空行
1.頂級函數和類之間有兩行空行
2.類內部的函數定義之間有一行空行
4.源文件編碼方式
1.Python3默認文件編碼格式utf-8
2.Python3中不應有編碼聲明
5.調整代碼格式 :ctrl + alt +L
2.注釋
1.行內注釋
1.行注釋是與代碼語句同行的注釋。行注釋和代碼至少要有兩個空格分隔。注釋由
#和一個空格開始
2.塊注釋
適用於跟隨他們的某些代碼,並縮進到與代碼相同的級別。塊注釋的每一行開頭使用一個
#和一個空格
塊注釋內部的段落通過只有一個#的空行分隔
3.文檔注釋
1.文檔注釋應當使用:3個引號 """ 。來包裹
2.要為所有的公共模塊,函數,類以及方法編寫文檔說明
3.非公共方法沒有必要添加文檔注釋,但是應該有一個描述方法具體作用的注釋。
這個注釋應該在def那一行之后
4.單行文檔注釋:"""注釋""",引號和文字在同一行
5.多行文檔注釋:多行文檔注釋由一個摘要行組成,就像一行文檔字符串,后面跟一個
空行,后面是更詳細的描述,多行文檔說明使用的結尾三引號應該自成一行
例子:
"""摘要。
注釋的正文
。。。。。。
"""
3.模塊和包相關規范
1.導入代碼位置
1.導入常常位於文件頂部,在文檔字符串之后,在全局變量和常量之前
2.導入順序分組:
1.標准庫導入
2.相關的第三方導入
3.特定的本都應用/庫導入
例子:
推薦:
import requests
不推薦
from requests import get
4.命名規范
1.變量命名
永遠不要使用字母 l,大寫字母O,作為變量名
2.函數命名
函數名應該小寫,多個單詞使用 _ 連接
3.類命名
首字母大寫,多個單詞使用 _ 連接
4.類里面函數和方法參數
始終要將self 作為實例方法的第一個參數
始終要將cls 作為類靜態方法的第一個參數
5.包和模塊
模塊名稱要斷、使用小寫、並避免使用特殊符號,盡量保持模塊名稱簡單。無需單詞分開(不
推薦使用 _ 連接)
6.常量
所有字母大寫使用 _ 連接