PEP8 規范


PEP8 代碼規范

pycharm的代碼編排:

  縮進:使用4個空格,可以直接 Tab

  換行:換行可以直接設置自動換行,但是由於pep8規范,可以使用 \ 來換行

  空行:1、類與其他函數或代碼之間要空兩行,前后都要;

     2、類里面的函數方法之間要空一行;

     3、其他地方盡量不要空行。

 

pycharm文檔的編排:

  模塊:模塊內容的順序:

     1、先寫模塊說明,可以寫多行字符串(文檔字符串);

     2、寫import xxx;模塊的導入順序:先寫標准模塊、再寫第三方模塊、最后是自己的模塊;

        最好三者之間隔一行。

     3、寫全局變量和常數。

  模塊導入:不要用一個import導入幾個模塊,如:import numpy,os

  from xx import xx :這種方式,有可能會有沖突;如:from dan import student 和from sglor inport student;

     這里有兩個student,所以可以直接用import xx的方式。

 

空格的使用:

  1、各種括號的前面不要加空格,括號的右括號前也不要和內容有空格;如:print('' ),應該刪除這個空格;

  2、冒號,逗號,分號前不要加空格,后面叫一個空格;

  3、操作符的前后都加一個空格。操作符:運算符...

  4、函數默認參數使用的賦值符左右省略空格;

  5、不要將多個語句寫在一行;雖然可以用 ;號,這也是允許的,但是不好;

  6、if/for/which 這些語句,就算只有一個語句也要另起一行。

 

注釋:

  1、在一句語句末注釋,#符號與內容之間要有一個空格,如:# 123

  2、少在代碼后注釋,盡量使用行注釋;

 

文檔注釋:

  在pycharm中注釋(多行字符串注釋)的時候,不要使用 ''' ''',要使用""" """,即雙引號而不是單引號

  如:

class Animal:

  """

  這是一個類注釋

  """

  pass

 

命名的規范:

  1、模塊命名盡量短,使用全部小寫的方式,可以使用下划線;

  2、包命名盡量短,使用全部小寫的方式,並且不可以使用下划線;

  3、類命名時,要使用單詞串,並且首字母大寫,如:class AnimalDog:...

  4、函數命名使用全部小寫的方式,可以使用下划線;

  5、常量命名使用全部大寫的方式,可以使用下划線;

 

異常問題:

  1 、盡可能使用 ‘is’ 或 ‘is not’ 取代 ‘==’,比如 if x is not None 要優於if x ;

  2 、使用基於類的異常,每個模塊或包都有自己的異常類,此異常類繼承自Exception;

  3 、異常中不要使用裸露的except,except后跟具體的exceptions;

  5 、異常中try的代碼盡可能少。比如:

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM