為了讓逐漸增長的**具有統一的、易讀的、可拓展的程式設計風格,學習了google的開源風格,特別著重記錄了python相關的命名規範,以便在今後的程式設計中統一命名風格、方便後期維護。python中的命名python中的命名包括了變數、函式、方法、類、工具包和模組等實體,google給出了一系列命名規則建議,以統一**風格。
caution
盡量避免單字元的命名,但是可以在計數器和迭代器中使用for i in range(xx)/異常處理中使用 except error as e:
避免使用橫桿-,盡量使用下劃線
避免使用雙下劃線開頭的名稱,像__name__這樣的是python自己的保留關鍵字
下劃線開頭:
單下劃線_
開頭意味著受保護的內部變數/函式,不會被import
匯出
雙下劃線__
開頭意味著類的私有變數或方法
內部意味著模組內,類內私有/保護變數/方法;
類命名:利用駝峰命名法myclass
模組名:利用小寫下劃線法:my_modules.py
在測試時可能會有不同的書寫方法,例如test_
,或者testpop_emptystack
guido推薦的命名法:
實體公有風格
內部模組
my_module_one 小寫下劃線
_my_module_one
包my_package_one
類myclass 駝峰法
_myclass
函式my_function_one()
方法名class_metdod_one()
保護:_class_metdod_one()
私有:__class_metdod_one()
全域性變數
my_global_variable
_my_global_variable
區域性變數
my_local_variable
例項變數
my_instance_varible
保護:_my_instance_varible
私有:__my_instance_varible
全域性常量
my_global_constant
_my_global_constant
異常myexpection
匯入
每行只匯入乙個變數或者乙個模組,避免一行匯入多個模組:
在開頭匯入!!!
import os
import sys
import numpy as np
注釋短期注釋todo
,需要注意三點
at last:規範命名、做好注釋、利人利己
命名規範:google python
命名規範
python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...
Python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...
python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...