当前位置: 首页 > news >正文

Python——代码格式

代码格式

良好的代码格式可以提升代码的可读性。和其他语言不同,Python 代码的格式是 Python 语法的组成之一,不符合 Python 代码无法正常运行。

注释

注释是代码中穿插的辅佐性质的文字,用于标识代码的含义和功能,可以提高程序的可读性。程序运行时 Python 解释器会忽略注释。Python 程序中的注释分为单行注释和多行注释。

单行注释

单行注释以“#” 开头,用于说明当前行或之后代码的功能。单行注释既可以单独占一行,也可以位于标识的代码后面,和表示代码同占一行。请看实例:

print("Hello Python!")                    # 单行注释,打印 Hello Python!

为了保证注释的可读性,Python 官方建议:“#”  后面先添加一个空格,再添加相应的说明文字,如果单行注释和代码同占一行,注释和代码之间至少有两个空格。

多行注释

在 Python中,多行字符串(由三个单引号 ''' 或三个双引号 """ 包围的文本块)在某些情况下可以被视为一种实现多行注释的技巧。多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来

多行注释是由 3 对双引号包裹的语句,主要用于说明函数或类的功能,因此多行注释也被称为说明文档。Python 内置函数 print() 中的多行注释,请看实例:

 单引号(' ' ')
#!/usr/bin/python3 
'''
这是多行注释,用三个单引号
这是多行注释,用三个单引号 
这是多行注释,用三个单引号
'''
print("Hello, Python!")
多引号(" " ")
#!/usr/bin/python3 
"""
This is a comment
written in
more than just one line
"""
print("Hello, Python!")

拓展说明

在 Python 中,多行注释是由三个单引号 ''' 或三个双引号 """ 来定义的,而且这种注释方式并不能嵌套使用。当你开始一个多行注释块时,Python 会一直将后续的行都当作注释,直到遇到另一组三个单引号或三个双引号。

嵌套多行注释会导致语法错误。例如,下面的示例是不合法的:

'''
这是外部的多行注释
可以包含一些描述性的内容

    '''
    这是尝试嵌套的多行注释
    会导致语法错误
    '''
'''

在这个例子中,内部的三个单引号并没有被正确识别为多行注释的结束,而是被解释为普通的字符串。这将导致代码结构不正确,最终可能导致语法错误。

如果你需要在注释中包含嵌套结构,推荐使用单行注释(以#开头)而不是多行注释。

单行注释可以嵌套在多行注释中,而且不会引起语法错误。

'''
这是外部的多行注释
可以包含一些描述性的内容

# 这是内部的单行注释
# 可以嵌套在多行注释中
'''

这样的结构是合法的,并且通常能够满足文档化和注释的需求。

通过 _ _doc_ _ 属性可以获取 Python 对象的说明文档。以获取 print() 函数的说明文档为例

print(print.__doc__)

 运行代码,结果如下:

print("Hello world")
print(print.__doc__)

Hello world
Prints the values to a stream, or to sys.stdout by default.

  sep
    string inserted between values, default a space.
  end
    string appended after the last value, default a newline.
  file
    a file-like object (stream); defaults to the current sys.stdout.
  flush
    whether to forcibly flush the stream.

缩进

Python 代码使用“缩进”(即一行代码之前的空白区域)确定代码之间的逻辑关系和层次关系,Python 代码的缩进可以通过 “Tab” 键或空格键控制。输入空格是 Python 3 首选的缩进方法,一般使用 4 个空格表示一级缩进,Python 3 不允许混合使用 “Tab” 键和空格键。请看实例:

if True:
    print ("true")
else:
    print ("true")

代码缩进量的不同会导致代码语义的改变,Python 语言要求同一代码块的每行代码必须具有相同的缩进量。程序中不允许出现无意义或不规范的缩进,否则运行时会产生错误,请看实例:

if Ture:
   print ("Answer")
   print ("True")
else:
   print ("Answer")
 print ("Ealse")      # 缩进不一致,会导致运行错误

 上面最后一行代码的缩进量不符合规范,程序在运行后会出现错误,请看实例:

File "D:\语言编程\Python\fist_study\测试.py", line 6
    print ("False")      # 缩进不一致,会导致运行错误
                                        ^
IndentationError: unindent does not match any outer indentation level

语句换行

Python 官方建议每行代码不超过 79 个字符,如果代码过长应该换行。Python 会将圆括号、中括号和大括号中的进行隐式连接,可以根据这个特点在语句外测添加一对圆括号,实现过长语句的换行显示,请看实例:

string = ("Python 是一种面向对象的、解释型的计算机程序设计语言,"
             "由 Guido van Rossum 于 1989 年底发明。"
             "Python 第一个公开发行版发行于 1991 年,"
             "其源代码同样遵循 GPL (GUN General Public License) 协议。")

需要注意的是,原本由圆括号、中括号和大括号包裹的语句在换行时不需要另行添加圆括号,请看实例:

total = ['item_one', 'item_two',
                   'item_three','item_four','item_five'

注:有不当之处,请批评指正!谢谢~

相关文章:

  • 1.6、Java继承、构造方法、数组
  • 案例驱动的 IT 团队管理:创新与突破之路:第一章 重构 IT 团队管理:从传统到创新-2.1.1案例:某云计算公司技术负责人的“三维评估法“
  • 深度优先搜索(DFS)剪枝技术详解与C++实现
  • Python第五章02:函数的参数和练习
  • JavaWeb全链路学习:10、Mybatis
  • Spring(6)——Spring、Spring Boot 与 Spring MVC 的关系与区别
  • 前端组件、组件库使用指南
  • 【Linux】learning notes(4)cat、more、less、head、tail、vi、vim
  • Leetcode-2272. Substring With Largest Variance [C++][Java]
  • AI第一天 自我理解笔记--生成文本概率Top-k p 束搜索 贪心搜索温度
  • Python 鼠标轨迹算法 - 防止游戏检测
  • OSPF-4 2类LSA NetworkLSA
  • airtest用法
  • 欧税通:日本JCT标准申报的具体税率是多少?
  • N皇后问题——dfs解法(回溯+减枝+深搜)
  • Unreal Engine 5.4 (虚幻引擎5)中动画制作快捷键大全
  • 自动化测试脚本
  • 深入解析 Kubernetes Worker Node 组件
  • SpringBoot 第一课(Ⅲ) 配置类注解
  • 经历过的IDEA+Maven+JDK一些困惑
  • 编程和做网站那个号/谷歌seo代运营
  • 驾校官方网站 模板/网络营销是什么工作主要干啥
  • 做网站必须要注册公司么/专门的网页制作工具有
  • 做网站的为什么一直拖/seo有哪些经典的案例
  • 佛山哪家网站建设比较好/如何推广自己的产品
  • html5模板免费下载/seo网络优化培训