Flask 文檔注釋

2021-08-10 10:57 更新

文檔字符串約定:

所有的文檔注釋應為 Sphinx 可理解的 reStructuredText 格式，其格式根據(jù)注釋行數(shù)而變化。如果只有一行，閉合的三引號和開頭的三引號在同一行，否則開頭的三引號與文本在同一行，而閉合的三引號另起一行:

def foo():
    """This is a simple docstring"""


def bar():
    """This is a longer docstring with so much information in there
    that it spans three lines.  In this case the closing triple quote
    is on its own line.
    """

模塊標頭:

模塊標頭包含一個 utf-8 編碼聲明（即使沒有使用非 ASCII 字符，也始終推薦這么做）和一個標準的文檔注釋:

# -*- coding: utf-8 -*-
"""
    package.module
    ~~~~~~~~~~~~~~

    A brief description goes here.

    :copyright: (c) YEAR by AUTHOR.
    :license: LICENSE_NAME, see LICENSE_FILE for more details.
"""

請留意，合適的版權(quán)和許可證文件對于 Flask 擴展通過審核是必須的。

以上內(nèi)容是否對您有幫助：

← Flask 命名約定

Flask 注釋 →

寫筆記

我要補充