Skip to content

Commit 2e629bf

Browse files
committed
fix discussion swaroopch#43: take easier under different settings
1 parent 74c7320 commit 2e629bf

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

10.functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
函数(Functions)是指可重复使用的程序片段。它们允许你为某个代码块赋予名字,允许你通过这一特殊的名字在你的程序任何地方来运行代码块,并可重复任何次数。这就是所谓的*调用(Calling)*函数。我们已经使用过了许多内置的函数,例如 `len``range`
44

5-
函数概念可能是在任何不平凡的软件(无论使用的是何种编程语言)中**重要的构建块,所以我们接下来将在本章中探讨有关函数的各个方面。
5+
函数概念可能是在任何复杂的软件(无论使用的是何种编程语言)中**重要的构建块,所以我们接下来将在本章中探讨有关函数的各个方面。
66

77
函数可以通过关键字 `def` 来定义。这一关键字后跟一个函数的*标识符*名称,再跟一对圆括号,其中可以包括一些变量的名称,再以冒号结尾,结束这一行。随后而来的语句块是函数的一部分。下面的案例将会展示出这其实非常简单:
88

@@ -194,13 +194,13 @@ Python 有一个甚是优美的功能称作*文档字符串(Documentation Stri
194194

195195
函数的第一行逻辑行中的字符串是该函数的 *文档字符串(DocString)*。这里要注意文档字符串也适用于后面相关章节将提到的[模块(Modules)](./11.modules.md#modules)[类(Class)](./14.oop.md#oop)
196196

197-
该文档字符串所约定的是一串多行字符串,其中第一行以某一大写字母开始,以句号结束。第二行为空行,后跟的第三行开始是任何详细的解释说明。[^5]在此*强烈建议*你在有关你所有非凡功能的文档字符串中都遵循这一约定
197+
该文档字符串所约定的是一串多行字符串,其中第一行以某一大写字母开始,以句号结束。第二行为空行,后跟的第三行开始是任何详细的解释说明。[^5]在此*强烈建议*你在你所有重要功能的所有文档字符串中都遵循这一约定
198198

199199
我们可以通过使用函数的 `__doc__`(注意其中的*双下划綫*)属性(属于函数的名称)来获取函数 `print_max` 的文档字符串属性。只消记住 Python 将*所有东西*都视为一个对象,这其中自然包括函数。我们将在后面的[类(Class)](./14.oop.md#oop)章节讨论有关对象的更多细节。
200200

201201
如果你曾使用过 Python 的 `help()` 函数,那么你应该已经了解了文档字符串的用途了。它所做的便是获取函数的 `__doc__` 属性并以一种整洁的方式将其呈现给你。你可以在上方的函数中尝试一下——只需在程序中包含 `help(print_max)` 就行了。要记住你可以通过按下 `q` 键来退出 `help`
202202

203-
自动化工具可以以这种方式检索你的程序中的文档。因此,我*强烈推荐*你为你编写的所有不平凡的函数配以文档字符串。你的 Python 发行版中附带的 `pydoc` 命令与 `help()` 使用文档字符串的方式类似。
203+
自动化工具可以以这种方式检索你的程序中的文档。因此,我*强烈推荐*你为你编写的所有重要的函数配以文档字符串。你的 Python 发行版中附带的 `pydoc` 命令与 `help()` 使用文档字符串的方式类似。
204204

205205
## 总结
206206

@@ -220,4 +220,4 @@ Python 有一个甚是优美的功能称作*文档字符串(Documentation Stri
220220

221221
[^4]: 原文作 VarArgs Parameters,VarArgs 来自于英文“可变的”“自变量(一译变元,台译引数,也可以理解成参数)”两个英文单词的结合,即 **Var**iable **Arg**uments。
222222

223-
[^5]: 此处指的是以英文撰写的文档字符串内容。
223+
[^5]: 此处指的是以英文撰写的文档字符串内容。

0 commit comments

Comments
 (0)