写点什么

软件测试 / 测试开发丨明确的编码规范,避免冗余和混乱

作者:测试人
  • 2023-11-09
    北京
  • 本文字数:1410 字

    阅读完需:约 5 分钟

免费领取:测试资料+测试用例+简历模板+测试文档

编码规范

Guido 的重要见解之一是,代码的读取次数远多于编写次数。

提高代码的可读性并使其在各种 Python 代码中保持一致很重要。总结一句话就是 “可读性很重要”。

PEP 8 是 Python 官方推荐的代码风格指南,旨在提供一致的代码风格,使 Python 代码易于阅读、理解和维护。

PEP 是 Python Enhancement Proposal 的缩写,翻译成中文是“Python 增强建议书”,而 8 表示版本。

Python 官方完整 PEP 8 文档地址:https://www.Python.org/dev/peps/pep-0008/

缩进

在 Python 中,缩进是一种非常重要的语法规则,Python 使用缩进来确定代码的层次结构和执行顺序。

  • 建议使用 Tab 键实现缩进

  • 同一级别的代码块的缩进量必须相同

class Student(object):    def __init__(self, name, age):        self.name = name        self.age = age
def info(self): print(f"Name: {self.name}") if self.age >= 18: print("已成年") else: print("未成年")
复制代码

注释

注释,是指在代码中对代码功能进行解释的描述性文字,可以提高代码的可读性。注释的内容将被 Python 解释器忽略,并不会在执行结果中体现出来。

Python 中,提供 3 种类型的注释:

  • 单行注释 在 Python 中,使用 #作为单行注释的符号。注释从符号 #开始直到换行为止,其后面所有的内容都作为注释的内容而被 Python 解释器忽略。

# 我是一段注释
复制代码
  • 多行注释 在 Python 中,并没有一个单独的多行注释标记,而是将注释内容包含在一对三引号之间,这样的代码将被解释器忽略。由于这样的代码可以分为多行编写,所以也可以作为多行注释。

'''可以使用三单引号实现多行注释'''
"""可以使用三双引号实现多行注释"""
复制代码
  • 文档注释 文档注释实际是多行注释的一种特殊使用形式,为 Python 文件、模块、类或者函数等添加版权、功能,说明等信息,例如,下面的代码将使用多行注释为程序添加功能、开发者、版权、开发日期等信息,也经常用来解释代码中重要的函数、参数等信息,利于后续开发者维护代码。

def print(self, *args, sep=' ', end='\n', file=None): # known special case of print"""  print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default. Optional keyword arguments: file: a file-like object (stream); defaults to the current sys.stdout. sep: string inserted between values, default a space. end: string appended after the last value, default a newline. flush: whether to forcibly flush the stream. """ pass
复制代码

命名规范

命名规范在编写代码中起到了很重要的作用,通过使用有意义的命名,可以传达变量、函数和类的用途和含义,使其他人(包括自己)更容易理解代码的意图,避免错误的变量赋值或函数调用。并且当多人合作开发或维护代码时,一致的命名约定使团队成员能够更轻松地理解和修改彼此的代码。

具体包括:

  • 包名尽量短小,全小写字母,不推荐使用下划线;

  • 模块名尽量短小,全小写字母,可以使用下划线分隔多个字母;

  • 类名采用单词首字母大写形式,即 Pascal 风格;

  • 常量命名时全部采用大写字母,可以使用下划线;

  • 变量、函数名也是全小写字母,多个字母间用下划线_进行分隔;

  • 使用单下划线_开头的模块变量或者函数是受保护的;

  • 使用双下划线__开头的实例变量或方法是类私有的。

发布于: 刚刚阅读数: 6
用户头像

测试人

关注

专注于软件测试开发 2022-08-29 加入

霍格沃兹测试开发学社,测试人社区:https://ceshiren.com/t/topic/22284

评论

发布
暂无评论
软件测试/测试开发丨明确的编码规范,避免冗余和混乱_软件测试_测试人_InfoQ写作社区