コメント

コメント

1、コメント

1.1、コメントをブロック

「#」記号の後にスペースを 1 つ残し、段落を空白行で区切ります (「#」記号も必要です)

# 块注释
# 块注释
#
# 块注释
# 块注释

1.2. 行コメント

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

# 正确的写法
x = x + 1  # 边框加粗一个像素
# 不推荐的写法(无意义的注释)
x = x + 1 # x加1

1.3.

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

より重要なコメント セクションは複数の等号で区切られており、より目を引き、重要性を強調することができます

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

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

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

ドキュメント コメントは """ で始まり、最初の行は改行されません。複数行ある場合は、最後の行は改行する必要があります。以下は 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.
"""

ドキュメント コメント内の関数定義プロトタイプをコピーするのではなく、その特定の内容を詳細に説明し、特定のパラメーターと戻り値を説明します。 etc.

#  不推荐的写法(不要写函数原型等废话)
def function(a, b):
    """function(a, b) -> list"""
    ... ...
#  正确的写法
def function(a, b):
    """计算并返回a到b范围内数据的平均值"""
    ... ...

関数のパラメータや戻り値などの記述は、以下に示すように numpy 標準を採用しています

def func(arg1, arg2):
    """在这里写函数的一句话总结(如: 计算平均值).
    这里是具体描述.
    参数
    ----------
    arg1 : int
        arg1的具体描述
    arg2 : int
        arg2的具体描述
    返回值
    -------
    int
        返回值的具体描述
    参看
    --------
    otherfunc : 其它关联函数等...
    示例
    --------
    示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
    >>> a=[1,2,3]
    >>> print [x + 3 for x in a]
    [4, 5, 6]
    """

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

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

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