python函数的要求规范_基础python规范
⼀、注释
合理的代码注释应该占源代码的 1/3 左右,Python 语⾔允许在任何地⽅插⼊空字符或注释,但不能插⼊到标识符和字符串中间。
在 Python 中,通常包括 3 种类型的注释,分别是单⾏注释、多⾏注释和中⽂编码声明注释:
单⾏注释:
Python 中使⽤井号( # )作为单⾏注释的符号,语法格式为:# 注释内容
1 print('hello world') #这是⼀条注释
多⾏注释:
多⾏注释通常⽤来为 Python ⽂件、模块、类或者函数等添加功能描述等信息,使⽤三单引号或三双引号作为多⾏注释符号,同时,也是长字符串符号。
1 st = '''
2 ⽇照⾹炉⽣紫烟,
3 遥看瀑布挂前川。
4 飞流直下三千尺,
css的作用和特点5 疑是银河落九天。
6 '''
中⽂编码声明注释:
主要⽤来解决 Python 2.x 中不⽀持直接写中⽂的问题,中⽂编码声明注释的语法有如下 2 种:
# -*- coding:编码 -*-python基础代码注释
或者
# coding=编码
1 #-*- coding: UTF-8 -*-
⼆、缩进规则
Python 采⽤代码缩进和冒号( : )来区分代码块之间的层次。
对于类定义、函数定义、流程控制语句、异常处理语句等,⾏尾的冒号和下⼀⾏的缩进,表⽰下⼀个代码块的开始,⽽缩进的结束则表⽰此代码块的结束。
Python 中实现对代码的缩进,可以使⽤空格或者 Tab 键实现。但⽆论是⼿动敲空格,还是使⽤ Tab 键,通常情况下都是采⽤ 4 个空格长度作为⼀个缩进量(默认情况下,⼀个 Tab 键就表⽰ 4 个空格)。
三、编码规范
Python 采⽤ PEP 8 作为编码规范,下⾯列出⼀些常见的编码规则:
每个 import 语句只导⼊⼀个模块,尽量避免⼀次导⼊多个模块;
不要在⾏尾添加分号,也不要⽤分号将两条命令放在同⼀⾏;
建议每⾏不超过 80 个字符,如果超过,建议使⽤⼩括号将多⾏内容隐式的连接起来,⽽不推荐使⽤反斜杠进⾏连接;
使⽤必要的空⾏可以增加代码的可读性,通常在顶级定义(如函数或类的定义)之间空两⾏,⽽⽅法定义之间空⼀⾏,另外在⽤于分隔某些功能的位置也可以空⼀⾏;
datetimepicker控件透明通常情况下,在运算符两侧、函数参数之间以及逗号两侧,都建议使⽤空格进⾏分隔。
四、标识符命名规范
标识符主要作⽤就是作为变量、函数、类、模块以及其他对象的名称,命名规则如下:
标识符是由字符(A~Z 和 a~z)、下划线和数字组成,但第⼀个字符不能是数字;
标识符不能和 Python 中的保留字相同;
Python中的标识符中,不能包含空格、@、% 以及 $ 等特殊字符;
标识符中的字母是严格区分⼤⼩写的;
以下划线开头的标识符有特殊含义:
以单下划线开头的标识符(如 _width),表⽰不能直接访问的类属性,其⽆法通过 import* 的⽅式导⼊;
以双下划线开头的标识符(如__add)表⽰类的私有成员;
以双下划线作为开头和结尾的标识符(如 __init__),是专⽤标识符;
Python允许汉字作为标识符,但应避免使⽤汉字作为标识符;
当标识符⽤作模块名时,应尽量短⼩,并且全部使⽤⼩写字母,可以使⽤下划线分割多个字母,例如 game_mian;
phpcms getshell当标识符⽤作包的名称时,应尽量短⼩,也全部使⽤⼩写字母,不推荐使⽤下划线,例如 ;
标识符的规则当标识符⽤作类名时,应采⽤单词⾸字母⼤写的形式。例如,定义⼀个图书类,可以命名为 Book;
模块内部的类名,可以采⽤ "下划线+⾸字母⼤写" 的形式,如 _Book;
函数名、类中的属性名和⽅法名,应全部使⽤⼩写字母,多个单词之间可以⽤下划线分割;
常量命名应全部使⽤⼤写字母,单词之间可以⽤下划线分割;
五、python关键字
关键字是 Python 语⾔中⼀些已经被赋予特定意义的单词,不能⽤这些保留字作为标识符给变量、函数、类、模板以及其他对象命名。使⽤以下命令查看关键字:
1 importkeyword
船舶deadweight
2 keyword.kwlist
六、python内置函数
使⽤内置函数作为标识符不会报错,但会导致同名函数被覆盖,⽆法使⽤。

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。