Python类和方法注释规范说明

def func(path, field_storage, temporary):
    '''基本描述
    详细描述
    :param path: The path of the file to wrap
    :type path: str
    :param field_storage: The :class:`FileStorage` instance to wrap
    :type field_storage: FileStorage
    :param temporary: Whether or not to delete the file when the File instance is destructed
    :type temporary: bool
    :returns: A buffered writable file descriptor
    :rtype: BufferedFileStorage
    '''
    pass

def func(path, field_storage, temporary):
    '''基本描述
    详细描述
    Parameters
    ----------
    path : str
        The path of the file to wrap
    field_storage : FileStorage
        The :class:`FileStorage` instance to wrap
    temporary : bool
        Whether or not to delete the file when the File instance is destructed
    Returns
    -------
    BufferedFileStorage
        A buffered writable file descriptor
    '''
    pass

def func(path, field_storage, temporary):
    '''基本描述
    详细描述
    Args:
        path (str): The path of the file to wrap
        field_storage (FileStorage): The :class:`FileStorage` instance to wrap
        temporary (bool): Whether or not to delete the file when the File instance is destructed
    Returns:
        BufferedFileStorage: A buffered writable file descriptor
    '''
    pass

num = 10
if num>5:
    print('yes')
else:
    print('no')

# if语句
if num>5:
    print('yes')
else:
    print('no')
 
# for循环
for i in (1,2,4):
    print(i)
 
# while循环
while i>3:
    print('yes')
    i+=1
else:
    print('end')
    
# 函数定义
def show():
    print(132)
 
# 类定义
class Person:
    def show(self):
        print(123)