python变量和常量命名、注释规范 |
您所在的位置:网站首页 › python中类名的命名规则 › python变量和常量命名、注释规范 |
学习python编程前先学习一下变量和常量命名规范以及注释规范,要从一开始就养成良好习惯,避免将来遇到一些不必要的麻烦。 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个参数的和 学生类 |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |