DocStrings
Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!
使用DocStrings
例子:
#!/usr/bin/python # Filename: func_doc.py def printMax(x, y): '''Prints the maximum of two numbers. The two values must be integers.''' x = int(x) # convert to integers, if possible y = int(y) if x > y: print x, 'is maximum' else: print y, 'is maximum' printMax(3, 5) print printMax.__doc__
输出
它如何工作
在函数的第一个逻辑行的字符串是这个函数的 文档字符串 。注意,DocStrings也适用于模块和类,我们会在后面相应的章节学习它们。
文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。
你可以使用__doc__
(注意双下划线)调用printMax
函数的文档字符串属性(属于函数的名称)。请记住Python把 每一样东西 都作为对象,包括这个函数。我们会在后面的类一章学习更多关于对象的知识。
如果你已经在Python中使用过help()
,那么你已经看到过DocStings的使用了!它所做的只是抓取函数的__doc__
属性,然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)
。记住按q退出help
。
自动化工具也可以以同样的方式从你的程序中提取文档。因此,我 强烈建议 你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令,与help()
类似地使用DocStrings。
相关推荐
### Python初学教程:《简明Python教程》 #### 知识点概述: 根据所提供的《简明Python教程》部分信息,我们可以归纳出一系列重要的Python基础知识和技术要点,这些内容非常适合Python初学者作为入门指南。 #### ...
### Python初学教程知识点概述 #### 1. 引言 - **Python的特色**: - 高级、解释型、通用编程语言; - 语法简洁清晰,易于学习; - 支持多种编程范式:面向对象、过程化、函数式等。 - **为什么选择Python而...
- 字符串是Python中最常用的数据类型之一,用于表示文本。 - 支持各种格式化输出方式。 - **变量与标识符**: - 变量用于存储数据,遵循一定的命名规则。 - 标识符的命名应遵循Python的命名规范。 - **数据...
### 官方Python3教程知识点总结 #### 一、Python3简介 **1.1 Python3的特点** - **高效的数据结构:** Python3内置了一系列高效的数据结构,如列表(list)、字典(dict)等,方便数据处理。 - **面向对象编程:** ...
简明 Python 教程 概括.......30 第6章控制流......31 简介.......31 if语句.....31 while语句...........34 for循环...36 break语句...........37 continue语句.......39 概括.......40 第7章函数..........
Python的特色 概括 为什么不使用Perl? 程序员的话 2. 安装Python Linux和BSD用户 Windows®用户 概括 3. 最初的步骤 简介 使用带提示符的解释器 挑选一个编辑器 使用源文件 输出 它如何工作 可...
《简明Python教程》是一本为初学者准备的Python语言学习书籍,内容涵盖了从安装Python、基础知识到面向对象编程的各个方面。它也适用于有经验的程序员,帮助他们理解Python的特性和使用方法。 2. Python的安装: 书...
【Python初学教程:《简明Python教程》】 Python是一种多用途、易读性强的编程语言,适合初学者和有经验的程序员。本教程旨在帮助读者掌握Python的基础知识,包括安装、基本概念、运算符、控制流、函数、模块、数据...
Python 教程简明指南 本资源为 Python Programming 语言的详细教程,共分为 16 章,涵盖了 Python 语言的基础知识、控制流、函数、模块、数据结构、面向对象编程、输入/输出、异常错误处理等方面的内容。该教程旨在...
Python的特色 概括 为什么不使用Perl? 程序员的话 2. 安装Python Linux和BSD用户 Windows®用户 概括 3. 最初的步骤 简介 使用带提示符的解释器 挑选一个编辑器 使用源文件 输出 它如何工作 可执行...
chm版的python教程 例子 3.1 使用带提示符的Python解释器 3.2 使用源文件 4.1 使用变量和字面意义上的常量 5.1 使用表达式 6.1 使用if语句 6.2 使用while语句 6.3 使用for语句 6.4 使用break语句 6.5 使用...
以上总结了《简明Python教程》的关键知识点,这些内容不仅为初学者提供了Python编程的基础,也为有经验的开发者提供了有用的参考和复习资料。通过学习这些核心概念和技术,读者可以更好地理解和掌握Python编程语言。
### 知识点总结:《简明Python教程》——Python入门宝典 #### 1. 引言:Python的魅力 《简明Python教程》作为一本备受推崇的Python入门教材,其核心价值在于清晰、简洁地介绍了Python语言的基础知识,适合初学者及...
### 《简明 Python 教程》核心知识点详解 #### 1. 引言与 Python 特色 - **引言**:本书旨在为不同背景的学习者提供学习 Python 的资源,无论初学者还是有一定编程经验的人都能从中受益。 - **Python 特色**: - ...