python中有哪些注释规范

本篇文章给大家分享的是有关python中有哪些注释规范，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。

取名时要遵循一些原则，通常变量、常量是指某一事物或事物的某一属性，所以变量名、常量名通常使用英文的一个或多个名词命名。而方法(又称函数)是指执行某一动作，所以方法(函数)名通常使用英文的动词或动词和名词组合命名。在编写代码时提前准备好英汉双语词典软件很有必要。我的英语不太好，在手机上安装了微软必应词典，在编程时一边查一边记，强迫自己养成使用英语命名的习惯。

常量

字母全部大写，由下划线连结各个单词，如：

HEIGHT = 300
WINDOW_HEIGHT = 300

注意在python中常量是python程序员约定俗成的规矩，实质上python解释器并不限制修改常量的值。

变量、函数、类的实例

全部小写命名，由下划线连接各给单词，如：

new_id = 1001
old_id = 1
new_id_list = []

私有属性，变量名以下划线开头即表示私有属性。

_salary = 6666

类名

首字母大写，用驼峰风格，如：

class NewStudent(object):

模块和包

全部以小写字母组成，用下划线连接

系统保留命名

__xx__ ，这样的变量都是系统保留命名规则，程序员写的变量避免用这样的格式。

注释

单行注释可以单独写一行，也可写在代码行的末尾。
单行注释以#开头跟2各空格再跟#再跟一个空格，然后写注释，例如：

_salary = 6666  # 私有属性薪水，不能公开访问。

多行注释是指三单引号开头三单引号结尾之间的内容，三双引号开头三双引号结尾亦可。不能三单引号开头三双引号结尾，也不能三双引号开头三单引号结尾。
多行注释最常用的场合是给类、函数注释说明文档，例如：

def add_x_y(x, y):  # 下面的多行注释，'''开头位置一定要注意缩进，'''结束位置单独占一行可以不讲究缩进。
    '''这是个加法器，
输入2个参数，
返回这2个参数的和
'''
    return x + y

print(add_x_y.__doc__)  # __doc__是查看方法或类的说明文档，也可以用help(add_x_y)查看

class Student(object):
    '''学生类'''
    pass

print(Student.__doc__)

out:
这是个加法器，
输入2个参数，
返回这2个参数的和

学生类

以上就是python中有哪些注释规范，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注亿速云行业资讯频道。