标准注释规范

  • 文件注释举例:
# -*- coding: utf_8 -*-
# @Create   : 2021/8/20 9:06
# @Author   : yh
# @Remark   : 视频管理
  • 代码注释举例:
class VideoDelete(View):

    def post(self):
        """
        删除视频,支持单个code或者批量删除
        """
        check_params(self.request.POST, ['video_code'])
        return '删除视频成功', {'video_code': VideoServer().delete(**self.request.POST)}
  • 函数注释及返回值注释举例:【使用reStructuredText风格】
@staticmethod
def return_value(res: tuple) -> Union[int, tuple, None]:
    """
    用于直接返回结果集的函数,处理其返回值

    :param res: 错误信息及函数返回的数据
    :return: 返回信息
    """
    msg = res[0] if isinstance(res, tuple) else res
    if msg != BS_NOERROR:
        raise DBError(msg)
    if res:
        return res[1] if len(res) == 2 else res[1:]
    return None