Python学习之路--第五章注释、编码规范和参考文档-CSDN博客

本文链接：https://blog.csdn.net/m0_46157934/article/details/139756445

一、注释

用于注释说明程序的文字就是注释，被注释的语句，在程序运行的时候将会跳过不予执行。注释是为了提高代码的可读性，以及便于阅读与维护。建议在编写代码时，编写必要的注释，这是一个良好的编程习惯。
注释一般分为单行、多行、文件编码声明注释（简单了解）。

单行注释就是通过#号开头，后面编写注释内容。

# 这里是单行注释，程序运行时不予执行
print("hello world")

通过三对双引号或三对单引号进行多行注释。多行注释不能嵌套多行注释，否则将会报错。

"""
这是多行注释
print("hello world")
print("hello python")
print("hello java")
"""
print("hello C++")

>>>hello C++

文件编码声明注释放在py文件的首行，以#号开通，格式为：# coding:编码格式。

# coding:utf-8

print("这是一个案例")

Python中采用 PEP8 （python 增强建议书）作为编码规范。下面简要的写出部分规范。

通常使用多行注释来注释多行说明，单个函数或者某个步骤，一般使用单行注释。

使用一次TAB键，实现缩进，表示代码的层级关系。

每行不建议太长，可通过括号()来进行连接。

每行代码末尾不要使用分号。也不要通过分号将两条命令放在一行上。

运算符/逗号等两侧进行空格，使代码看起来比较规整。

适当的使用异常处理结果提高程序的容错性。

阅读官方文档是一个很重要的习惯，因为python中有很多的函数、类库等，不可能能够完整的记忆，此时查阅官方文档将是一个很好的方式。

官方文档中文地址：https://docs.python.org/zh-cn/3.8/

在这里插入图片描述