Python_Note22

Coding Style

程式碼風格（英語：Programming style）即程式開發人員所編寫原始碼的書寫風格。良好程式碼風格的特點是使程式碼易讀。

• 總結程式設計實踐中的經驗，程式碼風格的要素包括（但不限於）以下幾點：
• 名字的使用（參見：駝峰式大小寫、識別元命名約定、匈牙利命名法）
• 運算式與語句
• 常量的使用
• 注釋的使用
• 縮排（參見：縮排風格）
• 程式碼的布局

Python亦有一套規範
PEP 8 -- Style Guide for Python Code
https://www.python.org/dev/peps/pep-0008/

Pycharm已經有提供PEP 8 規範的檢查，只要依照其檢查就可以寫出同一風格的coding style。此外由於google本身也大量使用python來開發程式，所以他們也有提出一套自己的coding style，包括C++跟python等。若一個團隊需要統整編碼風格，那可以參考google這一份，會比自己看PEP 8後再客製化來的快。

google Python風格指南

英文

https://google.github.io/styleguide/pyguide.html

中文

http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/

Naming

Guidelines derived from Guido's Recommendations

Type	Public	Internal
Packages	lower_with_under
Modules	lower_with_under	_lower_with_under
Classes	CapWords	_CapWords
Exceptions	CapWords
Functions	lower_with_under()	_lower_with_under()
Global/Class Constants	CAPS_WITH_UNDER	_CAPS_WITH_UNDER
Global/Class Variables	lower_with_under	_lower_with_under
Instance Variables	lower_with_under	_lower_with_under (protected) or __lower_with_under (private)
Method Names	lower_with_under()	_lower_with_under() (protected) or __lower_with_under() (private)
Function/Method Parameters	lower_with_under
Local Variables	lower_with_under