《像计算机科学家一样思考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          # 速度,单位是米/秒

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

相关文章
|
10月前
|
存储 Linux iOS开发
Python入门:2.注释与变量的全面解析
在学习Python编程的过程中,注释和变量是必须掌握的两个基础概念。注释帮助我们理解代码的意图,而变量则是用于存储和操作数据的核心工具。熟练掌握这两者,不仅能提高代码的可读性和维护性,还能为后续学习复杂编程概念打下坚实的基础。
Python入门:2.注释与变量的全面解析
|
Python
【python从入门到精通】-- 第二战:注释和有关量的解释
【python从入门到精通】-- 第二战:注释和有关量的解释
187 0
|
数据采集 前端开发 Python
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
322 0
|
Python
python中注释使用连续的单行注释 #
【8月更文挑战第1天】
202 6
|
开发者 Python
Python中注释用途
【7月更文挑战第28天】
315 6
|
开发者 Python
Python 基础语法注释
【7月更文挑战第27天】
396 6
|
IDE API 开发工具
|
Python
python中注释使用三个引号 """ 或 '''
【8月更文挑战第1天】
1062 4
|
IDE 开发工具 Python
python3代码编程规范(命名、空格、注释、代码布局、编程建议等)
该文章详细介绍了Python3的编程规范,包括命名、空格使用、注释、代码布局等方面的最佳实践,帮助提升代码的可读性和一致性。
1502 0
|
语音技术 Python
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式

推荐镜像

更多