目录
1.注释的作用
在程序中对某些代码进行标注说明, 增强程序的可读性(现在让别人看懂,以后让自己看懂)
注释重点说明不是代码的语法,而是在该处的作用。
PS:养成做注释的习惯终身受益
2.单行注释
- 以 # 开头 , # 右边的所有东西都被当做说明文字 ,在代码前一行写注释
- 为了保证代码的可读性, # 后面建议先添加一个空格
- 示例代码如下 :
# 这是一条注释信息 print("hello python")
也可以在代码后面写注释
-
为了保证代码的可读性, 注释和代码之间 至少要有 两个空格
-
实例如下:
print("hello python") #这是一条注释
3.多行注释
- 要在 Python 程序中适用多行注释, 可以用一对 连续的 三个 引号 (单引号和双引号都可以)
- 示例代码如下:
""" 这是多行注释 当需要说明内容比较多时 使用多行注释 """ print("hello python")
4.注释规范
4.1 什么时候需要使用注释
- 注释不是越多越好,简单的代码不需要
- 对于 复杂的操作 , 应该在操作开始前协商若干行注释
- 对于 不是一目了然的代码, 应该在其行尾添加注释 ( 至少隔开代码 2 个空格 )
4.2 代码规范
- Python 官方提供有一系列 PED (Python Enhancement Proposals) 文档
- 官方英文语言规范文档
- 中文语言规范文档