优草派  >   Python

Python之中的注释有哪些要求?Python注释怎么写才好

罗西汉            来源:优草派

python之中注释是用来说明一段代码或者是某一个函数的功能和作用是什么的提示语句,它并不是真正的代码,它有特殊的格式进行约束以及需要遵循一定的要求。下面这篇文章将会详细介绍python之中写好一个注释的要求,一起往下看看吧。

Python之中的注释有哪些要求?Python注释怎么写才好

1.单行注释是以符号#开头的,注释的内容和符号需要间隔一个空格的距离,就像这样:

# This is Python

2.单行注释的编写位置一遍是在代码的上方或者代码的尾部,并且单行注释在一个逻辑语句之中只能写在具体功能实现的代码处而不是逻辑语句开始处,例如:

for x in range(10):
    print(i)    # 注释只能写在这,不能写在冒号的后面

3.多行注释的关键词是成对的三引号,并且三个引号都必须为单引号或者双引号,不能单双引号交叉使用。

4.多行注释只能写在代码块的上方,一般来说是用来说明某一个函数的作用是什么的。

5.多行注释的三引号在编写时最好是独占一行而不是挨着注释的内容去写,示例如下:

’’’
这是一个多行注释
’’’

6.注释之中的反斜杠也需要遵循python解释器的规则,需要使用转义字符进行转义或者写成两个反斜杠//这样的形式才不会报错。

7.对于一些功能明确的代码或者是非常简短的代码是不需要添加注释的,因为注释的本身作用就是对代码进行解释。

以上就是关于python注释有什么要求的全部内容了,希望对你有所帮助。

【原创声明】凡注明“来源:优草派”的文章,系本站原创,任何单位或个人未经本站书面授权不得转载、链接、转贴或以其他方式复制发表。否则,本站将依法追究其法律责任。
TOP 10
  • 周排行
  • 月排行