python文档字符串
来源:互联网 发布:无线网络优化方案.ppt 编辑:程序博客网 时间:2024/06/14 08:56
Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!
使用DocStrings
!/usr/bin/pythonFilename: func_doc.pydef 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__
输出
$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.
The two values must be integers.
它如何工作
在函数的第一个逻辑行的字符串是这个函数的 文档字符串 。
文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。
你可以使用doc(注意双下划线)调用printMax函数的文档字符串属性(属于函数的名称)。请记住Python把 每一样东西 都作为对象,包括这个函数。
如果你已经在Python中使用过help(),那么你已经看到过DocStings的使用了!它所做的只是抓取函数的doc属性,然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。
自动化工具也可以以同样的方式从你的程序中提取文档。因此,我 强烈建议 你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令,与help()类似地使用DocStrings。
0 0
- Python 文档化字符串
- Python docstring文档字符串
- python的文档字符串
- 3.14 Python文档字符串
- python文档字符串
- python打印文档字符串
- 1. python 文档字符串
- 【python coding 6:文档字符串】Python的文档字符串DocStrings
- python中的文档字符串(docString)
- python中的文档字符串(docString)
- 理解python中的文档字符串
- python中的文档字符串(docString)
- Python随笔之文档字符串(DocStrings)
- 三、Python:函数、模块、文档字符串
- Python中的文档字符串的作用
- 转:python中的文档字符串(docStri…
- python文档字符串查找应用---find()
- python整理笔记3---__doc__(文档字符串)
- php file unlink
- (OK)(OK) [android-x86-6.0-rc1] compile_Android-x86_64_in_IBM-X3650-M4.txt
- 7.6 打印出以下杨辉三角形(要求打印10行)
- 2016-7-15 杂感
- OpenCV video process
- python文档字符串
- java/android 对列表进行首字母排序
- Linux进程通信——消息队列
- 九度OJ 1026
- Redis学习笔记(十二)Redis实战之Redis + Jedis
- mq-订单创建流程通知
- Jacobian矩阵和Hessian矩阵
- java-数据结构-续
- 基于Spring注解的WebService接口,服务端编码与客户端调用