简述python的编程规范_python编程规范
一 代碼風格:
(0)參考google代碼規(guī)范:
*鏈接:http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/
(1)縮進:
*python通過縮進對齊來表達代碼邏輯:同一層次的語句必須有相同的縮進,每組這樣的語句稱為一個塊。
*不要混合使用制表符(tab)和空格來縮進,跨平臺時無法正常工作。強烈建議:每個縮進層次使用單個制表符或兩個或四個空格,選擇任一堅持使用,在vim中設置單個tab為四個空格。
(2)命名規(guī)則:
*類名:單詞首字母大寫。
*包名、模塊名、局部變量名、函數名:全小寫+下劃線。
*全局變量:全大寫+下劃線。
*python文件是以.py結尾的,從技術上講,只有在該文件需要被導入時才是必須的,但是絕大數python文件為了統(tǒng)一都以.py命名。一些文本編輯器通過.py后綴來檢測python文件,如果沒有后綴就無法使用諸如語法著色和自動縮進等功能。
(3)注釋和文檔:
*注釋要簡潔明了,并放在合適地方。
*文檔:Python可通過__doc__特別變量,來動態(tài)獲得文檔字符串。在模塊、類聲明或函數聲明中第一個沒有賦值的字符串可以用object.__doc__來訪問,object是一個模塊、類、函數的名字。
(4)模塊結構和布局(從上到下):
*起始行(只在unix/linux下使用,例如:/usr/bin/env python)
*模塊文檔(簡要介紹模塊功能以及重要全局變量的含義,模塊外可通過module.__doc__訪問這些內容)
*模塊導入(推薦導入順序:Python標準庫模塊、Python第三方模塊、應用程序自定義模塊)
*變量定義(這里定義的是全局變量,本模塊中所有函數都可直接使用)
*類定義語句(類的文檔變量是class.__doc__)
*函數定義語句(函數的文檔變量是function.__doc__)
*主程序(根據執(zhí)行模式調用不同函數,當模塊是被導入時,系統(tǒng)變量__name__就是模塊名字;模塊被執(zhí)行時,__name__的值為'__main__')
二 python的文檔資源
總結
以上是生活随笔為你收集整理的简述python的编程规范_python编程规范的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 好听的江湖侠客名字87个
- 下一篇: 原码一位乘法器设计_十分钟带你彻底搞懂原