一、注释的作⽤
通过⽤⾃⼰熟悉的语⾔,在程序中对某些代码进⾏标注说明,这就是注释的作⽤,能够⼤⼤增强程序的可读性
二、单⾏注释(⾏注释)
以 # 开头, # 右边的所有东⻄都被当做说明⽂字,⽽不是真正要执⾏的程序,只起到辅助说明作⽤
# 这是第⼀个单⾏注释 print("hello Python")
为了保证代码的可读性, # 后⾯建议先添加⼀个空格,然后再编写相应的说明⽂字
单⾏注释快捷键: ctl+/
在代码后⾯增加的单⾏注释
在程序开发时,同样可以使⽤ # 在代码的后⾯(旁边)增加说明性的⽂字,但是,需要注意的是,为了保证代码的可读性,注释和代码之间 ⾄少要有 两个空格
print("hello python") # 输出 `hello Python
三、多⾏注释(块注释)
如果希望编写的 注释信息很多,⼀⾏⽆法显示,就可以使⽤多⾏注释
要在 Python 程序中使⽤多⾏注释,可以⽤ ⼀对 连续的 三个 引号(单引号和双引号都可以)
示例代码如下:
""" 这是⼀个多⾏注释 在多⾏注释之间, 可以写很多很多的内容…… """ print("hello Python")
四、什么时候需要使⽤注释?
1. 注释不是越多越好,对于⼀⽬了然的代码,不需要添加注释
2. 对于 复杂的操作,应该在操作开始前写上若⼲⾏注释
3. 对于 不是⼀⽬了然的代码,应在其⾏尾添加注释(为了提⾼可读性,注释应该⾄少离开代码 2 个空格)
4. 绝不要描述代码,假设阅读代码的⼈⽐你更懂 Python,他只是不知道你的代码要做什么
在⼀些正规的开发团队,通常会有 代码审核 的惯例,就是⼀个团队中彼此阅读对⽅的代码
五、关于代码规范
Python 官⽅提供有⼀系列 PEP(Python Enhancement Proposals) ⽂档
其中第 8 篇⽂档专⻔针对 Python 的代码格式 给出了建议,也就是俗称的 PEP 8
⽂档地址:https://www.python.org/dev/peps/pep-0008/
⾕歌有对应的中⽂⽂档:http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
任何语⾔的程序员,编写出符合规范的代码,是开始程序⽣涯的第⼀步