Python通用编程规范-02注释

最新推荐文章于 2024-08-01 17:52:18 发布

zhao12501

最新推荐文章于 2024-08-01 17:52:18 发布

阅读量1.5k

点赞数

分类专栏： python笔记文章标签： python

本文链接：https://blog.csdn.net/zhao12501/article/details/115455082

版权

本文详细介绍了Python编程中的注释规范，包括类、接口和函数的注释位置，公共属性注释要求，模块注释格式，以及注释的一般建议。强调注释应清晰无二义性，与代码同步更新，避免使用缩写，并注重注释的适当比例。

摘要由CSDN通过智能技术生成

说明：功能描述除了描述类或接口功能外，还要写明与其他类或接口之间的关系；属性清单列出该类或接口的接口方法的描述；修改记录包括修改人，修改日期及修改内容。

正确示例：
class TreeError(libxmlError):
    """
    功能描述：
    接口：
    修改记录：
    """

说明：公共函数注释的内容包括功能描述、输入参数、输出参数、返回值、调用关系（函数、表）、异常描述，修改记录等。异常描述必须说明异常的含义及什么条件下抛出该异常，除描述函数内部抛出的异常外。

# 正确示例：
def load_batch(fpath):
    """
    功能描述：
    参数：
    返回值：
    异常描述：
    修改记录
    """

说明：行内注释的形式是在语句的上一行中加注释。行内注释要少用。它们应以#和一个空格作为开始。<

关注

专栏目录