python中有哪些注釋規范

本篇文章給大家分享的是有關python中有哪些注釋規范，小編覺得挺實用的，因此分享給大家學習，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

取名時要遵循一些原則，通常變量、常量是指某一事物或事物的某一屬性，所以變量名、常量名通常使用英文的一個或多個名詞命名。而方法(又稱函數)是指執行某一動作，所以方法(函數)名通常使用英文的動詞或動詞和名詞組合命名。在編寫代碼時提前準備好英漢雙語詞典軟件很有必要。我的英語不太好，在手機上安裝了微軟必應詞典，在編程時一邊查一邊記，強迫自己養成使用英語命名的習慣。

常量

字母全部大寫，由下劃線連結各個單詞，如：

HEIGHT = 300
WINDOW_HEIGHT = 300

注意在python中常量是python程序員約定俗成的規矩，實質上python解釋器并不限制修改常量的值。

變量、函數、類的實例

全部小寫命名，由下劃線連接各給單詞，如：

new_id = 1001
old_id = 1
new_id_list = []

私有屬性，變量名以下劃線開頭即表示私有屬性。

_salary = 6666

類名

首字母大寫，用駝峰風格，如：

class NewStudent(object):

模塊和包

全部以小寫字母組成，用下劃線連接

系統保留命名

__xx__ ，這樣的變量都是系統保留命名規則，程序員寫的變量避免用這樣的格式。

注釋

單行注釋可以單獨寫一行，也可寫在代碼行的末尾。
單行注釋以#開頭跟2各空格再跟#再跟一個空格，然后寫注釋，例如：

_salary = 6666  # 私有屬性薪水，不能公開訪問。

多行注釋是指三單引號開頭三單引號結尾之間的內容，三雙引號開頭三雙引號結尾亦可。不能三單引號開頭三雙引號結尾，也不能三雙引號開頭三單引號結尾。
多行注釋最常用的場合是給類、函數注釋說明文檔，例如：

def add_x_y(x, y):  # 下面的多行注釋，'''開頭位置一定要注意縮進，'''結束位置單獨占一行可以不講究縮進。
    '''這是個加法器，
輸入2個參數，
返回這2個參數的和
'''
    return x + y

print(add_x_y.__doc__)  # __doc__是查看方法或類的說明文檔，也可以用help(add_x_y)查看

class Student(object):
    '''學生類'''
    pass

print(Student.__doc__)

out:
這是個加法器，
輸入2個參數，
返回這2個參數的和

學生類

以上就是python中有哪些注釋規范，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。