注释

注释的作用
单行注释（行注释）
多行注释（块注释）

01. 注释的作用

使用用自己熟悉的语言，在程序中对某些代码进行标注说明，增强程序的可读性

02. 单行注释(行注释)

以 # 开头，# 右边的所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用
示例代码如下：

# 这是第一个单行注释
print("hello python")

为了保证代码的可读性，# 后面建议先添加一个空格，然后再编写相应的说明文字

在代码后面增加的单行注释

在程序开发时，同样可以使用 # 在代码的后面（旁边）增加说明性的文字
但是，需要注意的是，为了保证代码的可读性，注释和代码之间 至少要有 两个空格
示例代码如下：

print("hello python")  # 输出 `hello python`

03. 多行注释（块注释）

如果希望编写的 注释信息很多，一行无法显示，就可以使用多行注释
要在 Python 程序中使用多行注释，可以用 一对连续的三个引号(单引号和双引号都可以)
示例代码如下：

"""
这是一个多行注释在多行注释之间，可以写很多很多的内容……
"""
print("hello python")

什么时候需要使用注释？

注释不是越多越好，对于一目了然的代码，不需要添加注释
对于 复杂的操作，应该在操作开始前写上若干行注释
对于 不是一目了然的代码，应在其行尾添加注释（为了提高可读性，注释应该至少离开代码 2 个空格）
绝不要描述代码，假设阅读代码的人比你更懂 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/

任何语言的程序员，编写出符合规范的代码，是开始程序生涯的第一步

【python】注释相关推荐

python注释_不建议使用Java注释的正确方法
python注释几乎没有什么@Deprecated没有适当的文档看到@Deprecated方法更令人生气的了. 我感到失落. 我应该仍然使用该方法吗? 可能这不是开发人员的意图,这就是为什么他/她添 ...
python中文解释-python注释和2版本的中文乱码
python里面的注释一.普通注释单行注释: # 多行注释:'''内容''' """内容""" ----两种写法,一种是以三个单引号括起 ...
python使用什么注释语句和运算-怎么使用python注释语句
注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书,让人吐血! 千万不要认为你自己写的代码规范就可以不加注释,甩给别人一段没有注释的代码是对别人的不尊重,是非常自私的行为:你可以喜欢自虐, ...
python字符串input输入_5.print()函数、转义字符、python注释、常量、字符串、格式化输出、input()输入...
目录 1.内置函数:print() 2.转义字符: 3.python注释: 4.常量: 5.字符串: 6.格式化输出: 7.input()输入: 8.学习单词: 1.内置函数:print() prin ...
python注释以符号什么开始_python注释以什么符号开始
python中的注释有多种,有单行注释,多行注释,批量注释,中文注释也是常用的.python注释也有自己的规范,在文章中会介绍到.注释可以起到一个备注的作用,团队合作的时候,个人编写的代码经常会被多人 ...
使用sphinx为python注释生成docAPI文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成 ...
Python注释缩进不得当导致IndentationError: unexpected indent
def test():i=0 ''' aaaaaa '''while i < 5:'''bbbbbb''' print(i)i+=1if __name__ == '__main__':test( ...
关于python语言数值操作符、以下选项错误的是答案是_关于Python注释,以下选项中描述错误的是...
[多选题]Python中单下划线_foo与双下划线__foo与__foo__的成员,下列说法正确的是? [单选题]关于Python语言的注释,以下选项中描述错误的是 [单选题]下面代码的输出结果是 s ...
使用sphinx快速为你python注释生成API文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...
python 注释含注释_Python注释
python 注释含注释 Python注释 (Python comments) Comments in Python are used to improve the readability of th ...

【python】注释

注释

01. 注释的作用

02. 单行注释(行注释)

在代码后面增加的单行注释

03. 多行注释（块注释）

什么时候需要使用注释？

关于代码规范

【python】注释相关推荐

最新文章

热门文章