Python 编程规范

注释

包文件注释

方法一
```
""" 包的简要说明
"""
```
方法二
```
"""
包
"""
```

函数注释

参考numpy,

def fun(p0, p1):
    """
    简要描述`fun()`的功能.

    `fun()`的详细说明.

    Parameters
    ----------
    p0 : [参数类型]
        `p0`参数的说明
    p1 : [参数类型]
        `p1`参数的说明.
    
    Returns
    -------
    r0 : [返回值类型]
        返回值`r0`的说明.
    r1 : [返回值类型]
        返回值`r1`的说明.

    See Also
    --------

    Reference
    ---------

    Examples
    --------

    ```
    ```
    """