コメント

1、コメント

1.1、コメントをブロック

「#」記號の後にスペースを 1 つ殘し、段落を空白行で區(qū)切ります (「#」記號も必要です)

# 塊注釋
# 塊注釋
#
# 塊注釋
# 塊注釋

1.2. 行コメント

ステートメントを區(qū)切るには少なくとも 2 つのスペースを使用し、意味のないコメントを使用しないように注意してください

# 正確的寫法
x = x + 1  # 邊框加粗一個像素
# 不推薦的寫法(無意義的注釋)
x = x + 1 # x加1

1.3.

は、次の重要な部分で使用することをお勧めします。コード (またはより複雑な場所)。コメントを書ける方はコメントを書いてみてください。

より重要なコメント セクションは複數(shù)の等號で區(qū)切られており、より目を引き、重要性を強(qiáng)調(diào)することができます

app = create_app(name, options)
# =====================================
# 請勿在此處添加 get post等app路由行為 !!!
# =====================================
if __name__ == '__main__':
    app.run()

2. ドキュメント コメント ( Docstring)

ドキュメントとしての Docstring は、通常、モジュール、関數(shù)、クラスのヘッダーに表示されるため、__doc__ を通じてドキュメントを取得できます。 Python のオブジェクトのオブジェクト。エディターと IDE も Docstring に基づいて自動プロンプトが表示されます。

ドキュメント コメントは """ で始まり、最初の行は改行されません。複數(shù)行ある場合は、最後の行は改行する必要があります。以下は Google の docstring スタイルの例です。

# -*- coding: utf-8 -*-
"""Example docstrings.
This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.
Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::
        $ python example_google.py
Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""

ドキュメント コメント內(nèi)の関數(shù)定義プロトタイプをコピーするのではなく、その特定の內(nèi)容を詳細(xì)に説明し、特定のパラメーターと戻り値を説明します。 etc.

#  不推薦的寫法(不要寫函數(shù)原型等廢話)
def function(a, b):
    """function(a, b) -> list"""
    ... ...
#  正確的寫法
def function(a, b):
    """計(jì)算并返回a到b范圍內(nèi)數(shù)據(jù)的平均值"""
    ... ...

関數(shù)のパラメータや戻り値などの記述は、以下に示すように numpy 標(biāo)準(zhǔn)を採用しています

def func(arg1, arg2):
    """在這里寫函數(shù)的一句話總結(jié)(如: 計(jì)算平均值).
    這里是具體描述.
    參數(shù)
    ----------
    arg1 : int
        arg1的具體描述
    arg2 : int
        arg2的具體描述
    返回值
    -------
    int
        返回值的具體描述
    參看
    --------
    otherfunc : 其它關(guān)聯(lián)函數(shù)等...
    示例
    --------
    示例使用doctest格式, 在`>>>`后的代碼可以被文檔測試工具作為測試用例自動運(yùn)行
    >>> a=[1,2,3]
    >>> print [x + 3 for x in a]
    [4, 5, 6]
    """

ドキュメントのコメントは中國語と英語に限定されませんが、中國語を混在させないでくださいと英語

ドキュメント コメントはできるだけ長くしないでください。通常は 1 ～ 2 文で狀況を明確に説明できます。

モジュール、パブリック クラス、およびパブリック メソッドについては、ドキュメント コメントを記述できる人が行う必要があります。ドキュメントのコメントを書いてみてください