Python多行代码注释快捷键选中要注释的代码,按下ctrl+/注释
python 多行注释
注释是每一个程序必要的部分,也是一个好程序员的习惯,有以下3种方式:
1.”””注视内容”””,这一种最强大;
2.快捷键Alt + 3,需要首先选中要注释的行;
3.自己写一个函数,然后把内容丢进去,自动添加#。
python中的注释
python中的注释分为单行注释和多行注释:
1、单行注释:使用单行注释就是用#标注就行
# print(‘hello,world!’)
像以上的代码,编译器就不会去执行。
2、多行注释:多行注释需要使用到到三对引号,这里的引号单引号和双引号都行。
“””
zheshizhushi
“””
以上就是python中关于注释的讲解。
Python里的一些注释规范
写代码注释是一件很重要的事情,如果你写的一段函数给别人调用那么往往都需要配上一些基本的注释。写好代码可以让别人容易阅读你的代码。试想一 下:如果你在github上面找到一段你想要的代码,这段代码有200行,可能这些代码我们要进行改造,那么这时候如果代码中都没有恰当的注释,我们可能要用比较久的时间去通读一下他的代码。
python注释快捷键配图
相反,如果这些代码有一些恰当的注释,我们可能会更加好理解一点。学会注释是编码过程中不可或缺的一部分。那么什么样的注释才是规范的注释,才能让其他看你代码的人能快速的了解你得代码结构呢。我们今天就说一说 有关于Python的一些注释规范。
在说规范之前我们有必要先看以下Python的注释有哪些?
单行注释
多行注释
特殊注释
按照每一个注释进行简单的介绍(我们截选request库的一段文件):
第一行第二行:为上述所说的特殊注释,这两个注释也几乎是在你所编写的每一个py文件中应该存在的,正常情况下第一第二行通用格式。
关于 #!/usr/bin/env python
1、必须是文件的第一行
2、必须以#!开头
3、#!/usr/bin/env python告诉LINUX/UNIX去找到python的翻译器。
关于: # -*- coding: utf-8 -*-
1、基本上在文件的第二行,在#!/usr/bin/env python的下一行
2、python interpret如何解释字符串的编码
3、当你的文件中出现中文的时候,你必须使用它
第四到第十三行:为上述所说的所行注释。多行注释,以三个引号开始,三个引号结尾。这三个引号可以使单引号也可以是双引号。
1、一般类文档,函数文档,字符串之类的用双引号,变量用单引号。
第二十一行:我们所说的单行注释,单行注释以#开头标识。
你也可以连续多次使用#单行注释来代替多行注释,但是我们并不推荐那么做。
知道了上述的注释之后,我们需要知道的是在哪些场合使用哪些注释。
第一点:为了避免麻烦,在文件的开头加上这两句。
第二点:每一个Python文件的开头,紧接着第一点所说的两行代码之后,我们往往要写上关于这个模块即这个Python文件实现的功能一些注意点,可能会发生的错误,总之你得注释要让使用它的人很明白你得代码段。
为何要引入函数注释?
在 Python 2.x 中,由于缺少对函数参数和返回值进行注释的标准方法,所以很多工具和库为了填补这一空白,使用了不同的方式:
自定义 decorator
自定义 docstring 格式
向函数对象添加自定义属性
显然,由于机制和语法的广泛差异,这会在一定程度上引起混乱。
为了解决这个问题,Python 3.x 引入了函数注释,旨在提供了一种单一的、标准的方法,来将元数据与函数参数和返回值相关联。
注意: 注释是完全可选的。