最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Python函數(shù)注釋備注的寫法和使用方法

 更新時(shí)間:2026年01月18日 15:10:47   作者:小滿大王i  
在Python中,為函數(shù)添加備注主要通過文檔字符串(docstring) 實(shí)現(xiàn),這是Python官方推薦的最佳實(shí)踐,而非單純使用#單行注釋,下面我會(huì)詳細(xì)介紹不同風(fēng)格的函數(shù)備注寫法和使用方法,需要的朋友可以參考下

一、基礎(chǔ)寫法(單行文檔字符串)

適用于功能簡(jiǎn)單、參數(shù)和返回值都很明確的函數(shù)。

def add(a, b):
    """計(jì)算兩個(gè)數(shù)的和"""
    return a + b

# 查看函數(shù)備注的方法
print(add.__doc__)  # 輸出:計(jì)算兩個(gè)數(shù)的和
help(add)  # 更友好的交互式查看,會(huì)顯示函數(shù)簽名+備注

二、標(biāo)準(zhǔn)寫法(多行文檔字符串)

適用于功能復(fù)雜、有多個(gè)參數(shù)/返回值、需要說明異常的函數(shù),主流有兩種風(fēng)格:

1. Google風(fēng)格(最易讀,推薦新手使用)

def calculate_area(shape: str, width: float, height: float = None) -> float:
    """
    計(jì)算常見幾何圖形的面積。

    支持的圖形:矩形(rectangle)、三角形(triangle)
    
    Args:
        shape: 圖形類型,可選值為 "rectangle" 或 "triangle"
        width: 寬度/底邊長(zhǎng)(浮點(diǎn)型)
        height: 高度(浮點(diǎn)型),矩形可不傳(默認(rèn)等于width,即正方形)
    
    Returns:
        計(jì)算出的面積(浮點(diǎn)型)
    
    Raises:
        ValueError: 當(dāng)shape不是指定值,或?qū)?高為負(fù)數(shù)時(shí)拋出
    """
    if width < 0 or (height and height < 0):
        raise ValueError("寬/高不能為負(fù)數(shù)")
    
    if shape == "rectangle":
        height = height or width  # 未傳height時(shí)默認(rèn)正方形
        return width * height
    elif shape == "triangle":
        if not height:
            raise ValueError("三角形必須傳入height")
        return 0.5 * width * height
    else:
        raise ValueError(f"不支持的圖形類型:{shape}")

# 查看備注
help(calculate_area)

2. Sphinx風(fēng)格(常用于生成官方文檔)

def calculate_area(shape: str, width: float, height: float = None) -> float:
    """
    計(jì)算常見幾何圖形的面積。

    :param shape: 圖形類型,可選值為 "rectangle" 或 "triangle"
    :type shape: str
    :param width: 寬度/底邊長(zhǎng)(浮點(diǎn)型)
    :type width: float
    :param height: 高度(浮點(diǎn)型),矩形可不傳(默認(rèn)等于width)
    :type height: float
    :return: 計(jì)算出的面積
    :rtype: float
    :raises ValueError: 當(dāng)shape非法或?qū)?高為負(fù)時(shí)拋出
    """
    # 邏輯和上面一致(省略)
    pass

三、關(guān)鍵補(bǔ)充

  1. 文檔字符串的位置:必須緊跟函數(shù)定義行,且是函數(shù)內(nèi)的第一個(gè)語句。
  2. 類型注解(可選但推薦):像上面的shape: str-> float是Python 3.5+支持的類型注解,和文檔字符串配合,能讓函數(shù)的參數(shù)/返回值類型更清晰。
  3. 查看備注的常用方式
    • 函數(shù)名.__doc__:直接獲取文檔字符串文本。
    • help(函數(shù)名):格式化輸出函數(shù)的完整信息(含參數(shù)、備注、異常)。
    • IDE支持:PyCharm、VS Code等會(huì)自動(dòng)讀取文檔字符串,在調(diào)用函數(shù)時(shí)顯示提示。

總結(jié)

  1. Python函數(shù)備注首選文檔字符串(docstring),而非單行注釋,help()和IDE能識(shí)別它。
  2. 簡(jiǎn)單函數(shù)用單行docstring,復(fù)雜函數(shù)推薦Google風(fēng)格的多行docstring(易讀、易維護(hù))。
  3. 配合類型注解(如param: type),能讓函數(shù)的參數(shù)/返回值含義更清晰。

到此這篇關(guān)于Python函數(shù)注釋備注的寫法和使用方法的文章就介紹到這了,更多相關(guān)Python函數(shù)注釋備注內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • 解決Alexnet訓(xùn)練模型在每個(gè)epoch中準(zhǔn)確率和loss都會(huì)一升一降問題

    解決Alexnet訓(xùn)練模型在每個(gè)epoch中準(zhǔn)確率和loss都會(huì)一升一降問題

    這篇文章主要介紹了解決Alexnet訓(xùn)練模型在每個(gè)epoch中準(zhǔn)確率和loss都會(huì)一升一降問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
    2020-06-06
  • Python操作dict時(shí)避免出現(xiàn)KeyError的幾種解決方法

    Python操作dict時(shí)避免出現(xiàn)KeyError的幾種解決方法

    這篇文章主要介紹了Python操作dict時(shí)避免出現(xiàn)KeyError的幾種解決方法,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2020-09-09
  • python中的[1:]、[::-1]、X[:,m:n]和X[1,:]的使用

    python中的[1:]、[::-1]、X[:,m:n]和X[1,:]的使用

    本文主要介紹了python中的[1:]、[::-1]、X[:,m:n]和X[1,:]的使用,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2022-08-08
  • python判斷自身是否正在運(yùn)行的方法

    python判斷自身是否正在運(yùn)行的方法

    今天小編就為大家分享一篇python判斷自身是否正在運(yùn)行的方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
    2019-08-08
  • Pytest自定義用例執(zhí)行順序(推薦)

    Pytest自定義用例執(zhí)行順序(推薦)

    github 上有個(gè) pytest-ordering 插件可以控制用例的執(zhí)行順序,本文給大家介紹了Pytest自定義用例執(zhí)行順序,需要的朋友可以參考下
    2021-12-12
  • Python連接KingbaseES的實(shí)戰(zhàn)指南

    Python連接KingbaseES的實(shí)戰(zhàn)指南

    在數(shù)據(jù)庫(kù)國(guó)產(chǎn)化替代的大背景下,人大金倉(cāng)KingbaseES作為國(guó)產(chǎn)數(shù)據(jù)庫(kù)的佼佼者,其應(yīng)用生態(tài)日益完善,本文給大家介紹了使用了Python連接KingbaseES的Ksycopg2驅(qū)動(dòng),需要的朋友可以參考下
    2025-10-10
  • Python數(shù)字圖像處理基礎(chǔ)直方圖詳解

    Python數(shù)字圖像處理基礎(chǔ)直方圖詳解

    這篇文章主要介紹了Python數(shù)字圖像處理基礎(chǔ)直方圖詳解,本文對(duì)Python直方圖的定義、性質(zhì)、應(yīng)用以及Python直方圖的計(jì)算作了詳細(xì)的講解,有需要朋友可以借鑒參考下
    2021-09-09
  • 基于matplotlib+tkinter實(shí)現(xiàn)簡(jiǎn)單的繪圖系統(tǒng)

    基于matplotlib+tkinter實(shí)現(xiàn)簡(jiǎn)單的繪圖系統(tǒng)

    在理解matplotlib嵌入到tkinter中的原理之后,就已經(jīng)具備了打造繪圖系統(tǒng)的技術(shù)基礎(chǔ),所以本文來實(shí)現(xiàn)一個(gè)簡(jiǎn)單的繪圖系統(tǒng),感興趣的小伙伴小伙伴可以了解一下
    2023-08-08
  • python判斷列表的連續(xù)數(shù)字范圍并分塊的方法

    python判斷列表的連續(xù)數(shù)字范圍并分塊的方法

    今天小編就為大家分享一篇python判斷列表的連續(xù)數(shù)字范圍并分塊的方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
    2018-11-11
  • Django自定義用戶表+自定義admin后臺(tái)中的字段實(shí)例

    Django自定義用戶表+自定義admin后臺(tái)中的字段實(shí)例

    今天小編就為大家分享一篇Django自定義用戶表+自定義admin后臺(tái)中的字段實(shí)例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
    2019-11-11

最新評(píng)論

海丰县| 壤塘县| 临邑县| 甘泉县| 报价| 秦安县| 灵石县| 安福县| 娱乐| 长汀县| 巨野县| 苗栗县| 鹿泉市| 平邑县| 静安区| 闻喜县| 宜良县| 福贡县| 措美县| 丰县| 临城县| 温泉县| 天长市| 大化| 元谋县| 黎城县| 康马县| 茶陵县| 高台县| 磴口县| 来安县| 罗定市| 望都县| 南京市| 郯城县| 寿光市| 昌都县| 平塘县| 奇台县| 安岳县| 郴州市|