当前位置 : 主页 > 编程语言 > python >

python 代码规范

来源:互联网 收集:自由互联 发布时间:2021-06-25
Python注释(多行注释和单行注释)用法详解 Python单行注释 Python 中使用井号(‘#’)作为单行注释的符号,语法格式为: [[emailprotected] python] # cat demo.py # -*- coding:utf-8 -*- # python script 注

Python注释(多行注释和单行注释)用法详解

Python单行注释

Python 中使用井号(‘#’)作为单行注释的符号,语法格式为:

[[email protected] python]# cat demo.py 
# -*- coding:utf-8 -*-

#python script 注释#

print("test one")
[[email protected] python]# 

 

 

Python多行注释

 

cat: de: No such file or directory
#-*- coding:utf-8 -*-

‘‘‘
  1. 使用 3 个单引号分别作为注释的开头和结尾
  2. 可以一次性注释多行内容
  3. 这里面的内容全部是注释内容

  代码注释块 测试

one 
‘‘‘

print("test one")
[[email protected] python]# 

 

 

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""

 

 

 

Python中文编码声明注释

 

[[email protected] python]# cat demo2.py 
#-*- coding:utf-8 -*-
#coding:utf-8
#coding=utf-8

print("编码声明注释的三种方")
[[email protected] python]# 

 

 

 

 

Python缩进规则(包含快捷键)

在 Python 中,对于类定义、函数定义、流程控制语句、异常处理语句等,行尾的冒号和下一行的缩进,表示下一个代码块的开始,而缩进的结束则表示此代码块的结束。

注意,Python 中实现对代码的缩进,可以使用空格或者 Tab 键实现。但无论是手动敲空格,还是使用 Tab 键,通常情况下都是采用 4 个空格长度作为一个缩进量(默认情况下,一个 Tab 键就表示 4 个空格)

[[email protected] python]# cat demo3.py 
#coding:utf-8

‘‘‘
代码缩进
体重指数BMI=体重/身高的平方(国际单位kg/㎡)
‘‘‘

height=float(input("输出身高m:"))
weight=float(input("输入体重kg:"))
bmi=weight/(height*height)   #计算 bmi


if bmi<18.5:
    print("BMI指数为: "+str(bmi) )
    print("体重过轻")
if bmi>=18.5 and bmi<24.9:
    print("BMI指数为:"+str(bmi)) #输出BMI指数
    print("正常范围,注意保持")
if bmi>=24.9 and bmi<29.9:
    print("BMI指数为:"+str(bmi)) #输出BMI指数
    print("体重过重")
if bmi>=29.9:
    print("BMI指数为:"+str(bmi)) #输出BMI指数
    print("肥胖")
[[email protected] python]# 

 

 

 

 

Python编码规范(PEP 8)

1.每个 import 语句只导入一个模块,尽量避免一次导入多个模块,例如:

 

#推荐
import os
import sys
#不推荐
import os,sys

2.不要在行尾添加分号,也不要用分号将两条命令放在同一行,例如:

#不推荐
height=float(input("输入身高:")) ; weight=fioat(input("输入体重:")) ;

 

3.建议每行不超过 80 个字符,如果超过,建议使用小括号将多行内容隐式的连接起来,而不推荐使用反斜杠 \ 进行连接。例如,如果一个字符串文本无法实现一行完全显示,则可以使用小括号将其分开显示,代码如下:

[[email protected] python]# cat demo4.py 
#coding:utf-8

s1=(" python 代码规范,每行最好不要超过80 个字符,换行使用() "
"推荐" )

s2=("python 代码规范,    不建议使用反斜杠")

print(s1)
print(s2)
[[email protected] python]# 

 

 

 

Python标识符命名规范

Python 中标识符的命名不是随意的,而是要遵守一定的命令规则,比如说:

    1. 标识符是由字符(A~Z 和 a~z)、下划线和数字组成,但第一个字符不能是数字。
    2. 标识符不能和 Python 中的保留字相同。有关保留字,后续章节会详细介绍。
    3. Python中的标识符中,不能包含空格、@、% 以及 $ 等特殊字符。
      例如,下面所列举的标识符是合法的:

 

  1. 例如,下面所列举的标识符是合法的:
    UserID
    name
    mode12
    user_age

     

    以下命名的标识符不合法:
    4word    #不能以数字开头
    try          #try是保留字,不能作为标识符
    $money #不能包含特殊字符

     

  2. 在 Python 中,标识符中的字母是严格区分大小写的,也就是说,两个同样的单词,如果大小格式不一样,多代表的意义也是完全不同的。比如说,下面这 3 个变量之间,就是完全独立、毫无关系的,它们彼此之间是相互独立的个体。
    number = 0
    Number = 0
    NUMBER = 0

     

  3. Python 语言中,以下划线开头的标识符有特殊含义,例如:
    • 以单下划线开头的标识符(如 _width),表示不能直接访问的类属性,其无法通过 from...import* 的方式导入;
    • 以双下划线开头的标识符(如__add)表示类的私有成员;
    • 以双下划线作为开头和结尾的标识符(如 __init__),是专用标识符。
    因此,除非特定场景需要,应避免使用以下划线开头的标识符。


另外需要注意的是,Python 允许使用汉字作为标识符,例如:

你好 = "http://nihao.net"

但我们应尽量避免使用汉字作为标识符,这会避免遇到很多奇葩的错误。

标识符的命名,除了要遵守以上这几条规则外,不同场景中的标识符,其名称也有一定的规范可循,例如:

当标识符用作模块名时,应尽量短小,并且全部使用小写字母,可以使用下划线分割多个字母,例如 game_mian、game_register 等。
当标识符用作包的名称时,应尽量短小,也全部使用小写字母,不推荐使用下划线,例如 com.mr、com.mr.book 等。
当标识符用作类名时,应采用单词首字母大写的形式。例如,定义一个图书类,可以命名为 Book。
模块内部的类名,可以采用 "下划线+首字母大写" 的形式,如 _Book;
函数名、类中的属性名和方法名,应全部使用小写字母,多个单词之间可以用下划线分割;
常量命名应全部使用大写字母,单词之间可以用下划线分割;
 
网友评论