python编码规范
说明:
PEP 8 是 Python 官方推荐的代码风格指南,旨在提供一致的代码风格,使 Python 代码易于阅读、理解和维护。
Python官方完整PEP8文档地址:https://www.Python.org/dev/peps/pep-0008/
-
缩进
建议使用Tab键实现缩进
同一级别的代码块的缩进量必须相同 -
注释
# 这是一行单行注释,"#"后面需要留一个空格
class Student(object):
"""
这是多行注释
多行注释使用三个引号来包裹注释内容:
Python 文件、模块、类或者函数等添加版权、功能,说明等信息
"""
def __init__(self, name, age):
'''
这也是多行注释
:param name: 接收一个字符串类型的数据,用来表示姓名
:param age: 接收一个整型数字,用来表示年龄
'''
self.name = name
self.age = age
def info(self):
print(f"Name: {self.name}")
if self.age >= 18:
print("已成年")
else:
print("未成年")
-
命名规范
包名尽量短小,全小写字母,不推荐使用下划线:
from 包名 import 模块名 [as 别名]模块名尽量短小,全小写字母,可以使用下划线分隔多个字母:
import time类名采用单词首字母大写形式,即Pascal风格
Class Student常量命名时全部采用大写字母,可以使用下划线
PI变量、函数名也是全小写字母,多个字母间用下划线_进行分隔
student_manage使用单下划线_开头的模块变量或者函数是受保护的
_student :私有化,受保护的模块使用双下划线__开头的实例变量或方法是类私有的
init :私有化初始方法