Python 注释

Posted 2021-03-02 qiaofu520

1、注释：就是一段文字性的描述，用来对代码的解释和说明。

2、注释的特性：当程序被处理的时候，注释会被自动忽略，不会被当做代码处理。

3、注释的作用

① 帮助自己理清代码逻辑。

② 与他人合作开发时，能够减少沟通成本。

③ 开发模块时，可以减少他人的使用成本。

④ 临时注释一段代码，可以方便调试。

4、注释的分类

① 单行注释（又叫行注释）：使用#表示单行注释，#后面的这一行，会被当做注释在程序执行时被忽略。

② 多行注释（又叫块注释）：当注释内容过多，导致一行无法显示时，就可以使用多行注释，Python中使用三个引号对（单引号或双引号皆可）表示多行注释，也可以在多行行首添加#，即多个单行注释，达到多行注释的效果。

③ 特殊注释

1）# -*- coding: utf-8 -*-

这个特殊注释针对的是python2版本。

Python2默认使用ASCII编码（不支持中文），python3默认使用UTF-8编码（支持中文）。

所以，为了使python2中支持中文，就会在开头加上这个特殊注释。python3则并不需要这个。

这个声明有多种写法，如：# coding=urf-8、# encoding=utf-8或# -*- coding: utf-8 -*-都是合法有效的，但是推荐最后一种写法。

2）#!/usr/bin/env python

这个特殊注释只在linux系统下生效。

在linux环境中，写一个最简单的python程序并命名为hello.py

正常的，输入命令python hello.py 来执行这个程序。

 

如果在第一行有这样的声明：#!/usr/bin/python，那么只需要给这个py程序添加可执行权限，就可以用./hello.py来执行。

#!/usr/bin/python的意思就是说去/usr/bin目录下找python去执行。

理解了这一语句的初衷后，就应该分析#!/usr/bin/python和#!/usr/bin/env python二者的区别了。

#!/usr/bin/python的意思是说去/usr/bin/目录下找python去执行
#!/usr/bin/env python的意思是在/usr/bin/env中找到python的安装路径，然后去执行它，这个可执行的python路径不管是不是在/usr/bin下，用法比较灵活，而#!/usr/bin/python就写成了绝对路径，只能去/usr/bin下找

所以，推荐写成：#!/usr/bin/env python

5、Python注释规范

注释不是越多越好，对于一目了然的代码，不需要添加注释。对于不是一目了然的代码，应该在代码之后添加注释，对于复杂的操作，应该在操作开始前写上对应的注释。不要描述代码，一般阅读代码的人都了解python的语法，只是不知道代码要干什么。

Python官方提供有一系列PEP文档，其中第8篇文档专门针对Python的代码格式给出了建议，也就是俗称的PEP8。PEP8文档的链接：https://www.python.org/dev/peps/pep-0008/