python編碼規範與命名規範

阿新 • • 發佈：2019-01-20

編碼規範

不要在行尾加分號, 也不要用分號將兩條命令放在同一行.

每行不超過80個字元，Python會將圓括號, 中括號和花括號中的行隱式的連線起來 , 你可以利用這個特點. 如果需要, 你可以在表示式外圍增加一對額外的圓括號.例如：

x = ('This will build a very long long '

'long long long long long long string')

在註釋中，如果必要，將長的URL放在一行上。

# See details at

#http://www.example.com/us/developer/documentation/api/content/v2.0/

寧缺毋濫的使用括號.除非是用於實現行連線, 否則不要在返回語句或條件語句中使用括號. 不過在元組兩邊使用括號是可以的.
用4個空格來縮排程式碼.絕對不要用tab, 也不要tab和空格混用.
頂級定義之間空兩行. 方法定義之間空一行.頂級定義之間空兩行, 比如函式或者類定義. 方法定義, 類定義與第一個方法之間, 都應該空一行. 函式或方法中, 某些地方要是你覺得合適, 就空一行.
按照標準的排版規範來使用標點兩邊的空格.不要在逗號, 分號, 冒號前面加空格, 但應該在它們後面加(除了在行尾). 引數列表, 索引或切片的左括號前不應加空格.在二元操作符兩邊都加上一個空格, 比如賦值(=),

比較(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布林(and, or, not). 至於算術操作符兩邊的空格該如何使用, 需要你自己好好判斷. 不過兩側務必要保持一致.當’=’用於指示關鍵字引數或預設引數值時, 不要在其兩側使用空格.
塊註釋和行註釋.最需要寫註釋的是程式碼中那些技巧性的部分. 如果你在下次程式碼審查的時候必須解釋一下, 那麼你應該現在就給它寫註釋. 對於複雜的操作, 應該在其操作開始前寫上若干行註釋. 對於不是一目瞭然的程式碼, 應在其行尾添加註釋.為了提高可讀性, 註釋應該至少離開程式碼

2個空格.
如果一個類不繼承自其它類, 就顯式的從object繼承. 巢狀類也一樣.
每個匯入應該獨佔一行.匯入總應該放在檔案頂部.例如:

Yes: import os

import sys

No: import os, sys

通常每個語句應該獨佔一行.

命名規範

所謂”內部(Internal)”表示僅模組內可用, 或者, 在類內是保護或私有的.
用單下劃線(_)開頭表示模組變數或函式是protected的(使用import * from時不會包含).

用雙下劃線(__)開頭的例項變數或方法表示類內私有.

將相關的類和頂級函式放在同一個模組裡. 不像Java, 沒必要限制一個類一個模組.
對類名使用大寫字母開頭的單詞(如CapWords, 即Pascal風格), 但是模組名應該用小寫加下劃線的方式(如lower_with_under.py). 儘管已經有很多現存的模組使用類似於CapWords.py這樣的命名, 但現在已經不鼓勵這樣做, 因為如果模組名碰巧和類名一致, 這會讓人困擾.

Python之父Guido推薦的規範

Type	Public	Internal
Modules	lower_with_under	_lower_with_under
Packages	lower_with_under
Classes	Cap Words	_CapWords
Exceptions	Cap Words
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

python編碼規範與命名規範

編碼規範不要在行尾加分號, 也不要用分號將兩條命令放在同一行. 每行不超過80個字元，Python會將圓括號, 中括號和花括號中的行隱式的連線起來 , 你可以利用這個特點. 如果需要, 你可以

淺談Android編碼規範及命名規範

event err class wrap spa for循環 who 全局變量經典原文:淺談Android編碼規範及命名規範前言：　　目前工作負責兩個醫療APP項目的開發，同時使用LeanCloud進行雲端配合開發，完全單挑。　　現大框架已經完成，正在進行細節模

[轉載] Python程式碼規範和命名規範

http://www.imooc.com/article/19184?block_id=tuijian_wz#child_5_1 Python程式碼規範和命名規範前言 Python 學習之旅，先來看看 Python 的程式碼規範，讓自己先有個意識，而且在往後的學習中慢慢養成習慣

IOS編碼規範（命名規範）

⼀一.命名規則命名總則: 1.使⽤用駝峰法命名，命名清晰明瞭，要做到⾃自描述，不能省略，部分cocoa通⽤用縮略詞能夠縮寫。 Objective – C不⽀支援名字名稱空間，所以某些命名要加項⺫⽬目字首區別。需要加字首的地⽅方: 全域性變數，類名，全域性函式，categ

C++編碼規範(2):命名規範

如果你程式碼中的變數名,函式數,類名都取得很好,不僅是個有意義的詞或短語,而且確切的表達了該變數或函式的功能.那讀起程式碼來就像看文章一樣,絕對是一種享受.當然理想是美好的,現實可是殘酷的.很少有人能做到這樣.一來嘛你英語詞彙量得多,不樣不容易找到那麼多合適並貼切的

Java命名規範與註釋規範

在面向物件程式設計中，對於類，物件，方法，變數等方面的命名是非常有技巧的。比如，大小寫的區分，使用不同字母開頭等等。但究其本，追其源，在為一個資源其名稱時候，應該本著描述性以及唯一性這兩大特徵來命名

Python程式碼規範和命名規範

1、程式碼規範 1、編碼如無特殊情況, 檔案一律使用 UTF-8 編碼如無特殊情況, 檔案頭部必須加入#-*-coding:utf-8-*-標識 2、格式 2.1、縮排統一使用 4 個空格進行縮排 2.2、行寬每行程式碼儘量不超過 80 個字元(在

OpenGL學習02_函式語法與命名規範

OpenGL函式的命名規則函式的開頭字首為“gl”，並把組成函式的每個單詞的首字母用大寫形式表示（例如，glClearColor()）。類似地，OpenGL還定義了一些以字首GL_開頭的常量，所有的單詞都使用大寫形式，並以下劃線分隔（例如GL_COLOR_BUFFER_BI

編碼習慣之命名規範

選擇一個好的命名　　命名有兩個目標：清晰：你要知道該命名與什麼有關精確：你要知道該命名與什麼無關　　當一個命名完成上面兩個目標之後，其餘的字元就是多餘的了。下面是我在開發時的一些命名原則：　　命名中無需含有表示變數或引數型別的單詞　　如果使用如Java之

JavaSript模塊規範 - AMD規範與CMD規範介紹[轉]

開始使用得到 uid des 擴展先來封裝 script 原文地址：http://blog.chinaunix.net/uid-26672038-id-4112229.html JavaSript模塊化在了解AMD，CMD規範前，還是需要先來簡單地了解下什麽是

Python 編碼轉換與中文處理

import 字符 recent call python safari 測試重新 open Python 編碼轉換與中文處理python 中的 unicode是讓人很困惑、比較難以理解的問題. utf-8是unicode的一種實現方式，unicode、gbk、gb2312

AMD 規範與CMD 規範概要

命名衝突和檔案依賴，是前端開發過程中的兩個經典問題。通過模組化開發來解決。 AMD 規範在這裡：https://github.com/amdjs/amdjs-api/wiki/AMD CMD 規範在這裡：https://github.com/seajs/seajs/issues/242 AMD 是 Req

前端開發規範之命名規範、html規範、css規範、js規範

在學習程式設計的時候，每次看到那些整齊規範的程式碼，心裡頓時對這個程式設計師表示點點好感，有時，比如看到自己和朋友寫的程式碼時，那閱讀起來就是苦不堪言，所以，一些基本的開發規範是必須的，是為了自己方便閱讀程式碼，也方便他人閱讀修改程式碼。命名

JAVA書寫規範、命名規範

書寫規範花括號不要單獨一行，和它前面的程式碼同一行。而且，花括號與前面的程式碼之間用一個空格隔開。public void method() { // Good } public voi

前端開發規範：命名規範、html規範、css規範、js規範

本文首發於我的個人網站：http://cherryblog.site/ （背景更換了不知道大家有沒有發現呢，嘻嘻）一個好的程式設計師肯定是要能書寫可維護的程式碼，而不是一次性的程式碼，怎麼能讓團隊當中其他人甚至一段時間時候你再看你某個時候寫

前端開發規範之命名規範

HTML: 1.單標記標籤統一加/結尾 2.所有跟資料有關的按鈕都用input 3.定位屬性要寫全，為0不省略 4.給有事件的元素統一加類 5.單獨模組用section包起來,class是模組名 6.導航，footer單獨之外，其餘的儘量用一個大的容

Python 編碼規範(Google) （轉）

present clas stmt 刪除規範實的 things code uno Python 風格規範(Google) 本項目並非 Google 官方項目, 而是由國內程序員憑熱情創建和維護。如果你關註的是 Google 官方英文版, 請移步 Google St

Python命名規範

total sel ror error oca 情況重載導入動態 Google Python命名規範 module_name, 模塊 package_name, 包 ClassName, 類 method_name, 方法 ExceptionName, 異

python編程規範與代碼優化建議

運行三引號時間 gui 順序 con 關系運算符運行速度擴展 1.嚴格使用縮進來體現代碼的邏輯從屬關系。　　python對代碼的縮進是硬性要求，這一點必須時刻註意。如果某個代碼段的縮進不對，那麽整個程序就是錯的，要麽是語法錯誤無法執行，要麽是邏輯錯誤導致錯誤結果，

PEP8 Python 編碼規範整理[轉]

長度 sys ret 換行效率一行操作 style 命名沖突 PEP8 Python 編碼規範,僅供參考，不必完全遵守。一代碼編排1 縮進。4個空格的縮進（編輯器都可以完成此功能），不使用Tab，更不能混合使用Tab和空格。2 每行最大長度79，換行可以使用反斜杠

python編碼規範與命名規範

相關推薦