今天是Andy學Python的第42 天哦!
大家好,我是Andy。
今天主要總結一下代碼編寫的規範。
01.
縮進
可以使用Tab鍵或4個空格縮進,但不能在同一程序中混用。
推薦:使用4個空格縮進。
02.
空行
推薦:每個類、函數定義和一段完整的功能代碼之後增加一個空行。
03.
空格
總體原則,避免不必要的空格:
在二元運算符兩邊各加一個空格[=,==, <, >, !=,<>, <=, >=,in, not in, is, is not];
算術操作符左右各加一個空格;
左括號之後,右括號前不要加空格;
逗號、冒號、分號之前不要加空格,之後要加空格(除了行尾);
函數、列表、字典的左括號前不要加空格,如Func(1)、list[2]、dic[1];
函數的參數列表中,逗號之後要有空格;
函數的參數列表中,默認值等號兩邊不要添加空格;
不要爲了對齊增加空格(適用於: # =等)。
04.
行寬
儘量不要寫過長的語句。
一般來說,一行代碼的長度應不超出屏幕寬度或80個字符。
以下情況除處:
長的導入模塊語句
註釋裏的URL
不建議使用反斜槓連接行。
推薦使用圓括號將多行括起來表示是一條語句。
05.
註釋
5.1 塊註釋
“#”號後空一格,段落間用空行分開(同樣需要“#”號)
5.2 行註釋
至少使用兩個空格和語句分開,注意不要使用無意義的註釋
對於複雜的操作,應該在其操作開始前寫上若干行註釋。
對於不是一目瞭然的代碼,或者有技巧性的部分,應在其行尾添加註釋。
不要描述代碼,註釋應說明本句或本段的目的或用意。
5.3 文檔註釋(Docstring)
一般出現在模塊頭部、函數和類的頭部。
文檔註釋以三個單引號或三個雙引號開頭和結尾,首行不換行,如有多行,末行必需換行。
文檔註釋不是越長越好,通常一兩句話能把情況說清楚即可。
5.4 建議
在代碼的關鍵部分(或比較複雜的地方),能寫註釋的要儘量寫註釋。比較重要的註釋段,使用多個等號隔開,可以更加醒目,突出重要性。
06.
選擇合適的數據類型
如果定義一些數據只是用來頻繁遍歷,最好優先考慮元組或集合。如果需要頻繁地測試一個元素是否存在於一個序列中並且不關心其位置,應採用集合。列表和元組的in操作時間複雜度是線性的,而對於集合和字典卻是常數級的,與問題規模幾乎無關。在所有內置數據類型中,列表的功能最強大,但佔用內存最多,運行速度最慢,應慎重使用。作爲建議,應優先考慮使用集合和字典,元組次之,最後再考慮列表。
07.
import
每個import語句只導入一個模塊,並且要按照標準庫、擴展庫、自定義庫的順序依次導入。不使用的包或模塊庫不要導入,不要兩個文件循環導入。
from turtle import * # 不要出現這種前期省事後期頭大的import *
08.
編寫代碼順序
在編寫代碼時,應優先使用Python內置對象、函數和類型,其次考慮使用Python標準庫提供的對象,最後考慮使用第三方擴展庫。
51Day Day up!
向上向善,日進一步!
每天學習,努力成長!
定個小目標,開啓成長的旅程,遇見更好的自己。
這是我們和自己的約定,許諾自己不負韶華。
路雖遠,行則將至;事雖難,做則必成。
成長的最好時機,就是當下。