Flask 文檔注釋

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

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.
    """

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

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

    A brief description goes here.

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

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