注释

目标

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

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注释格式_Python 注释
1.注释:就是一段文字性的描述,用来对代码的解释和说明. 2.注释的特性:当程序被处理的时候,注释会被自动忽略,不会被当做代码处理. 3.注释的作用 ① 帮助自己理清代码逻辑. ② 与他人合作开发时, ...
python使用符号#表示单行注释-【经济金融及Python应用讲义】Python编程规范之注释...
原标题:[经济金融及Python应用讲义]Python编程规范之注释来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么 ...
python使用符号表示单行注释-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
Python 编码规范 TODO注释
如: # TODO(Dontla): 提取filenames中数字# TODO(Dontla): 重新构建并写入文件快捷键:alt+6 ,快速找出所有待办TODO 参考文章1:Python编码规范- ...
python代码大全中文注释_零基础小白必看篇：Python代码注释规范代码实例解析操作（收藏）...
本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!! 一.代码注释介绍注释就是对代码的解释和说明 ...
python代码_零基础小白必看篇：Python代码注释规范代码实例解析操作（收藏）
本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!! 一.代码注释介绍注释就是对代码的解释和说明 ...
python代码注释规范-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
Python 编程规范 —— TODO 注释（结合 PyCharm）
编程是代码和注释的统一: TODO 自然表示需要做而未做的一些待完成的事项,有助于事后的检索,以及对整体项目做进一步的修改迭代. # TODO(kl@gmail.com): Use a "* ...
Python 代码规范
前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯目录 Python代码规范一.简明概述 1.编码如无特殊情况, 文件一律使用 U ...

Python注释规范

注释

目标

01. 注释的作用

02. 单行注释(行注释)

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

03. 多行注释（块注释）

什么时候需要使用注释？

关于代码规范

Python注释规范相关推荐

最新文章

热门文章