Python命名,注釋等編碼規範

2021-10-24 14:25:55 字數 2854 閱讀 9228

1.1 命名規範包名

全部小寫字母,中間可以由點分隔開,不推薦使用下滑線。
模組名

全部小寫字母,如果多個單詞構成,可以用下劃線隔開。如dummy_threading.
類名

採用大駝峰法命名。如splitviewcontroller
異常名

異常屬於類,命名同類命名,但應以error作為字尾。如filenotfounderror
變數名

全部小寫字母,如果多個單詞構成,可用下劃線隔開。如果變數應用於模組或函式內,則變數名可以由單下劃線開頭;

變數類內部私有使用變數名可以雙下劃線開頭。不要命名雙下劃線開頭和結尾的變數,這是python保留的。

另外,避免使用小寫l大寫o和大寫i作為變數名。

函式名和方法名

命名同變數命名。如balance_account,_push_cm_exit
常量名

全部大寫字母,如果是由多個單詞構成,可以用下劃線隔開。如year,week_of_month
擴充套件

大駝峰法命名是駝峰命名的一種,駝峰命名是指混合使用大小寫字母來命名。

駝峰命名分為小駝峰法和大駝峰法。

小駝峰法就是第乙個單詞全部小寫,後面的單詞首字母大寫。如myroomcount;

大駝峰法是第一各單詞的首字母也大寫。如classroom.

1.2 注釋規範

python中注釋的語法有三種:單行注釋,多行注釋和文件注釋。

以下說明如何規範使用。

1,檔案注釋

檔案注釋就是在每乙個檔案開頭新增注釋,採用多行注釋。(每行加#號)

檔案注釋通常包括版權資訊,檔名,所在模組,作者資訊,歷史版本資訊,檔案內容和作用等。

2, 文件注釋

文件注釋就是文件字串,注釋內容能夠生成api幫助文件。一般給一些看不到源**的人看的幫助文件。

可以使用python官方提供的pydoc工具從python源**檔案中提取這些資訊,也可生成html檔案。

所有公有的模組,函式,類和方法都應該進行文件注釋。

文件注釋使用一對三重雙引號「"""」包裹起來,應位於被注釋的模組,函式,類和方法內部的第一條語句。

如果文件注釋一行能夠注釋完成,結束的三重雙引號也在同一行。

如果文件注釋很長,第一行注釋之後要留乙個空行,然後剩下的注釋內容換行要與開始三重雙引號對齊,

最後結束的三重雙引號要獨佔一行,並於開始三重雙引號對其。

3, **注釋

一般採用單行和多行注釋。

4, 使用todo注釋

todo注釋不是python官方所提供,但主流ide工具也都支援todo注釋。

todo注釋說明此處有待處理的任務或**沒有編寫完成。

1.3 匯入規範

匯入語句總是放在檔案頂部,位於模組注釋和文件注釋之後,模組全域性變數和常量之前。

每個匯入語句只能匯入乙個模組,但如果from import後面跟有多個**元素是可以的。

匯入語句應該按照從通用到特殊的順序分組。順序是:標準庫->第三方庫->自己模組。

每一組之間有乙個空行,而且組中模組是按照英文本母順序排列的。

1.4 **排版

**排版包括空行,空格,斷行和縮排等內容。

**排版內容多,工作量大,非常重要。

一,空行

空行用以將邏輯相關**段分隔開,以提高可讀性。

1,import語句塊前後保留兩個空行(共四個空行)。

2,函式或類宣告之前保留兩個空行。

3,方法宣告之前保留乙個空行。

4,兩個邏輯**塊之間應保留乙個空行。

二,空格

1,賦值符號「="前後各有乙個空格。 a = 10 , b = 20

2,所有二元運算子都應該使用空格與運算元分開。 a += c + d

3,一元運算子:演算法運算子取反"-"和運算子取反"~".

4,括號內不要有空格,python中括號包括小括號"()",中括號""和大括號"{}". doque(cat[1],,)

5,不要在逗號,分號,冒號前面有空格,而是要在他們後面又乙個空格,除非該符號已經是行尾了。

if x == 88:

print(x, y)

x, y = y, x

6,引數列表,索引或切片的左括號前不應有空格。

doque(1)

dogs['key'] = list[index]

三,縮排

4個空格常被作為縮排排版的乙個級別。不要使用製表符縮排(八個空格)。
四,斷行

一行**中最多79個字元,對於文件注釋和多行注釋時一行最多72個字元。

如果注釋中包含url位址可以不受這個限制。

如果超過限制則需要斷行。

斷行位置可以是:

1,在逗號後面斷開。

2,在運算子前面斷開。

3,盡量不要使用續行符"\",當有括號(無論大中小)則在括號中斷開,這樣可以不使用續行符。

擴充套件

在python中反斜槓"\"可以作為續行符使用,告訴直譯器當前行和下一行是連線在一期的。

但在大括號,中括號和小括號中續行是隱式的。

Python編碼規範之命名規範

1 不要使用小寫字母 l el 大寫字母 o oh 或者小寫 i 作為單獨變數名稱。因為一些字型中,上訴字母和數字很難區分 比如 o和0,l和1 2 module應該採用全小寫,並且盡可能短的命名,可以在模組名中使用下劃線以提高可讀性。package應該採用全部小寫,並且也要盡可能短的命名,但不允許...

編碼規範 注釋

1 源程式注釋量需要達到 總量的20 以上。2 為類編寫詳細的說明性檔案,格式如下 author lian lekai version 1.0.1 date 2015 01 21 description 後台管理系統主檔案,主要作用是 others function list 1 註冊 2 登入 3...

規範 前端編碼規範 注釋規範

頂部新增檔案申明資訊,包括檔案描述 原始作者,如果有更新,則需要新增更新內容 更新作者和更新時間。description 說明文字 author 張三 description 說明文字 author 張三 update 更新內容 by 李四 2013 04 13 18 32 無論是單行注釋還是多行注...