Commentaire

Commentaires

1, commentaires

1.1, bloquer les commentaires

Il y a un espace après le signe "#", et les paragraphes sont séparés par des lignes vides (le signe "#" est également obligatoire )

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

1.2. Les commentaires en ligne

doivent être séparés des déclarations par au moins deux espaces. Attention à ne pas utiliser de commentaires dénués de sens

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

1.3. Il est recommandé que

puisse écrire des commentaires en clé. parties du code (ou des endroits plus complexes) Essayez d'écrire des commentaires

des sections de commentaires plus importantes, séparées par plusieurs signes égal, peuvent être plus accrocheuses et souligner l'importance

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

2. Docstring en tant que document apparaît généralement dans l'en-tête du module. L'en-tête du département, de la fonction et de la classe, afin que le document puisse être obtenu via l'objet __doc__ de l'objet en python. Les éditeurs et les IDE peuvent également donner des invites automatiques basées sur la Docstring.

Les commentaires des documents commencent et se terminent par """, les premières lignes ne sont pas interrompues. S'il y a plusieurs lignes, la dernière ligne doit être interrompue. Ce qui suit est un exemple du style docstring de Google

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

Ne copiez pas la fonction. prototype de définition dans le commentaire de la documentation, mais décrivez son contenu spécifique, expliquez les paramètres spécifiques et les valeurs de retour, etc.

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

La description des paramètres de fonction, des valeurs de retour, etc. adopte la norme numpy, comme indiqué ci-dessous

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

Commentaires sur la documentation ne se limitent pas au chinois et à l'anglais, mais ne mélangez pas le chinois et l'anglais

Les commentaires sur la documentation ne sont pas aussi longs que possible, généralement une ou deux phrases peuvent expliquer la situation. Expliquez simplement clairement

Modules, cours publics, méthodes publiques Ceux-là. qui peut rédiger des commentaires sur la documentation devrait faire de son mieux pour rédiger des commentaires sur la documentation