參與協同 << Previous Next >> 命名規則

註解規則

所有 Modules、Classes 與 Functions 都應該加上 doc string，一般 Methods 應比照 Functions，而 __init__ 等則視情況在程式碼中添加單行註解。

# -*- coding: utf-8 -*-

"""Module doc string title

Module decriptions ...
"""


def function():
    """Single line doc string."""
    ...


class MyClass:

    """MyClass doc string."""

    def method():
        """MyClass.method doc string."""
        ...

使用單行註解多行程式碼時，為求功能明確，應在該區域使用單空行分隔。

def foo() -> List[Set[int]]:
    """foo doc string."""
    a = 10
    b = 20

    # Let a plus b, and assign to c.
    c = a + b

    # Do another things ...
    d = func_c2d(c)
    e = func_c2e(c)
    f = func_de2f(d, e)

    # Convert f.
    return list(f)

參與協同 << Previous Next >> 命名規則