《像计算机科学家一样思考Python(第2版)》——2.7 注释

简介:

本节书摘来自异步社区《像计算机科学家一样思考Python(第2版)》一书中的第2章,第2.7节,作者[美] Allen B. Downey,赵普明 译,更多章节内容可以访问云栖社区“异步社区”公众号查看。

2.7 注释

当程序变得更大更复杂时,读起来也更困难。形式语言很紧凑,经常会遇到一段代码,却很难弄清它在做什么、为什么那么做。

因此,在程序中加入自然语言的笔记来解释程序在做什么,是个好主意。这种笔记被称为注释(comments),它们以#开头:

# compute the percentage of the hour that has elapsed
percentage = (minute * 100) / 60

在这个例子里,注释单独占据一行。也可以把注释放到代码行的结尾:

percentage = (minute * 100) / 60 # percentage of an hour

从#开始到行尾的注释内容都会被解释器忽略掉—它们对程序本身运行没有任何影响。

注释最重要的用途在于解释代码并不显而易见的特性。我们可以合理地认为读者可以看懂代码在做什么,因此使用注释来解释为什么这么做,要有用得多。

下面这段注释与代码重复,毫无用处:

v = 5          # 将5赋值给v

而下面这段注释则包含了代码中看不到的有用信息:

v = 5          # 速度,单位是米/秒

选择好的变量名称,可以减少注释的需要,但长名字也会让复杂表达式更难阅读,所以这两者之间需要衡量舍取。

相关文章
|
4月前
|
数据采集 Python
【Python自动化】多线程BFS站点结构爬虫代码,支持中断恢复,带注释
【Python自动化】多线程BFS站点结构爬虫代码,支持中断恢复,带注释
30 0
|
6月前
|
Python
03 python - 注释
03 python - 注释
15 0
|
5月前
|
定位技术 Python
【python】pygame实现植物大战僵尸小游戏(附源码 有注释)
【python】pygame实现植物大战僵尸小游戏(附源码 有注释)
442 1
|
5月前
|
Python
【python】PyQt5实现生成二维码并保存的功能(附源码,带注释)
【python】PyQt5实现生成二维码并保存的功能(附源码,带注释)
48 0
|
5月前
|
存储 Python
Python基础语法之注释、缩进、数字类型、一句多行和多行一句等的讲解及演示(超详细 附源码)
Python基础语法之注释、缩进、数字类型、一句多行和多行一句等的讲解及演示(超详细 附源码)
39 0
|
27天前
|
Python
02-python的基础语法-01python字面量/注释/数据类型/数据类型转换
02-python的基础语法-01python字面量/注释/数据类型/数据类型转换
|
1月前
|
Java 程序员 编译器
初识Python(注释、代码缩进、编码规范、标识符、变量)
初识Python(注释、代码缩进、编码规范、标识符、变量)
35 2
|
2月前
|
算法 程序员 C++
【Python 基础教程 05】超详细解析Python3注释:全面入门教程,初学者必读,了解Python如何 进行注释
【Python 基础教程 05】超详细解析Python3注释:全面入门教程,初学者必读,了解Python如何 进行注释
152 1
|
2月前
|
Java 编译器 C语言
python基础语法——常量、变量、注释、输入输出和运算符
本文基于pycharm编译器,也可以使用Anaconda 里的编译器,将讲解一些python的一些基础语法知识。可以和我写的python数据分析——Python语言基础(语法基础)结合起来看,有些知识点可能在这篇文章写的不是很全面
22 0
|
2月前
|
Python
Python-字符串与注释
Python-字符串与注释
10 1