1. 首頁 > 生活百科 > >

Python程序注釋寫在什么位置？Python在代碼什么位置添加多行注釋

生活百科python

python程序中有些代碼是需要添加注釋來解釋它的構造和功能的，而一些初學python的小伙伴對于注釋該寫在什么位置就不是很了解了 。所以本文會來給大家介紹一下python中注釋的四種添加位置，想要學習這個知識的話就一起往下看看 。

Python程序注釋寫在什么位置？Python在代碼什么位置添加多行注釋


一、頂部
頂部注釋又被稱之為文件頭注釋，它只能夠寫在一個python腳本文件內代碼編寫的最頂部，并且對于注釋內容有嚴格要求 。這些注釋都是添加#符號的單行注釋，內容為解釋器路徑、編碼格式以及版本和開發者信息等等，示例如下：
#!/usr/bin/env python# -*-coding:utf-8 -*-#@Author：Schiller Xu#@Version：1.0二、代碼尾部
當行注釋可以寫在代碼的尾部，并且只有單行注釋能夠寫在這個位置，處于該位置的代碼注釋一般是用來描述這行代碼的作用以及運行之后會產生的結果 。寫注釋時需要使用四個空格，也就是一個縮進的距離將其和代碼隔開，示例如下：
print(’輸出’)    # 尾部注釋三、代碼上方
而單行注釋和多行注釋都是可以寫在代碼上方的，代碼上方的注釋一般是用來解釋該行代碼的結構，例如說此代碼是定義變量之類的，示例如下：
【Python程序注釋寫在什么位置？Python在代碼什么位置添加多行注釋】# 注釋一a = 10’’’注釋二’’’a = 33四、函數內部
還有另外一種比較特殊的注釋是需要寫在函數內部第一行代碼處的，因為它會被解析函數文檔，而這個函數文檔的作用就是去描述函數參數是什么類型有什么用，以及該函數的功能和結果是什么，代碼示例如下所示：
def average(a, b, c):    """    該函數用于計算三個數的平均值，并返回一個結果    :param a: int_第一個數    :param b: int_第二個數    :param c: int_第三個數    :return: 返回一個計算結果    """    d = (a + b + c) // 3    print("平均數為：", d)    return d以上就是關于“Python程序注釋寫在什么位置？Python在代碼什么位置添加多行注釋”的全部內容了，希望對你有所幫助 。

    猜你喜歡