国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 編程 > Python > 正文

python 編碼規范整理

2020-02-23 00:01:00
字體:
來源:轉載
供稿:網友

一 代碼編排

1 縮進4個空格的縮進(編輯器都可以完成此功能),不要使用Tap,更不能混合使用Tap和空格。
2 每行最大長度79,換行可以使用反斜杠,最好使用圓括號。換行點要在操作符的后邊敲回車。
3 類和top-level函數定義之間空兩行;類中的方法定義之間空一行;函數內邏輯無關段落之間空一行;其他地方盡量不要再空行。

二 文檔編排

1 模塊內容的順序:模塊說明和docstring—import—globals&constants—其他定義。其中import部分,又按標準、三方和自己編寫順序依次排放,之間空一行。
2 不要在一句import中多個庫,比如import os, sys不推薦。
3 如果采用from XX import XX引用庫,可以省略‘module.',都是可能出現命名沖突,這時就要采用import XX。

三 空格的使用

總體原則,避免不必要的空格。

1 各種右括號前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函數的左括號前不要加空格。如Func(1)。
4 序列的左括號前不要加空格。如list[2]。
5 操作符左右各加一個空格,不要為了對齊增加空格。
6 函數默認參數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行,盡管使用‘;'允許。
8 if/for/while語句中,即使執行語句只有一句,也必須另起一行。

四 注釋

總體原則,錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時,第一件事就是要修改注釋!
注釋必須使用英文,最好是完整的句子,首字母大寫,句后要有結束符,結束符后跟兩個空格,開始下一句。如果是短語,可以省略結束符。

1 塊注釋,在一段代碼前增加的注釋。在‘#'后加一空格。段落之間以只有‘#'的行間隔。

2 行注釋,在一句代碼后加注釋。比如:x = x + 1 # Increment x
但是這種方式盡量少使用。
3 避免無謂的注釋。

五 文檔描述

1 為所有的共有模塊、函數、類、方法寫docstrings;非共有的沒有必要,但是可以寫注釋(在def的下一行)。
2 如果docstring要換行,參考如下例子,詳見PEP 257

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名規范總體原則,新編代碼必須按下面命名風格進行,現有庫的編碼盡量保持風格。

總體原則,新編代碼必須按下面命名風格進行,現有庫的編碼盡量保持風格。
1 盡量單獨使用小寫字母‘l',大寫字母‘O'等容易混淆的字母。
2 模塊命名盡量短小,使用全部小寫的方式,可以使用下劃線。
3 包命名盡量短小,使用全部小寫的方式,不可以使用下劃線。
4 類的命名使用CapWords的方式,模塊內部使用的類采用_CapWords的方式。

發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表
主站蜘蛛池模板: 岳池县| 聂荣县| 平度市| 洞口县| 奇台县| 灵宝市| 望江县| 简阳市| 读书| 蒲江县| 宁强县| 平顶山市| 通渭县| 玉林市| 恩平市| 黄梅县| 营口市| 旅游| 宁化县| 鹿泉市| 大同县| 阿瓦提县| 青川县| 合水县| 冀州市| 北宁市| 常熟市| 平舆县| 南陵县| 阜阳市| 梅河口市| 阳信县| 福州市| 榆林市| 青阳县| 钟山县| 开阳县| 永仁县| 阳朔县| 招远市| 同江市|