[Python]编码规范性(四)——注释(属性、格式)

属性

(必须遵守)(规则):

3、公共属性的注释写在属性声明的上方,与声明保持同样的缩进;

行内注释应以#和一个空格作为开始,与后面的文字注释以一个空格隔开;

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

格式

(必须遵守)(规则):

4、模块文档字符串写在文件的顶部,导入(import)部分之前的位置,不需要缩进;

说明:模块文档字符串应当包含功能描述和版权说明;

"""
功能:XXX类,该类主要涉及XXX功能;
版权信息:MoKin Studio 版本所有(C) 2010-2021
"""

5、文档字符串多于一行时,末尾的"""要自成一行;

说明:对于只有一行的文档字符串,把"""放到同一行也没有问题;

6、注释必须与其描述的代码保持同样的缩进,并放在其上方相邻位置;

说明:对代码的注释应放在其上方相邻位置,不可以放在下面;

原文地址:https://www.cnblogs.com/LeeCookies/p/15524278.html