python3 DocStrings 函数有什么用？求详解

zjj

以下是我用python3写的  其中用到 DocStrings，教材参考上说他很重要，建议经常使用，但是我看不出来他有什么作用，输出和 print 一样= = ！究竟是什么回事？是做什么用的？？求教最好详细些，谢谢~~~

                               
登录/注册后可看大图

福禄娃娃

Python有一个很奇妙的特性，称为 文档字符串 ，它通常被简称为 docstrings 。DocStrings是一个重要的工具，由于它帮助你的程序文档更加简单易懂，你应该尽量使用它。你甚至可以在程序运行的时候，从函数恢复文档字符串！

1. def printMax(x, y):
   
2.     '''Prints the maximum of two numbers.
   
3.     The two values must be integers.'''
   
4.     x = int(x)
   
5.     y = int(y)
   
6. 
   
7.     if x > y:
   
8.         print(x, "is maximum.")
   
9.     else:
   
10.         print(y, "is maximum.")
    
11. 
    
12. printMax(3, 5)
    
13. print(printMax.__doc__)
    
14. help(printMax)
    

复制代码

输出结果为

5 is maximum.
Prints the maximum of two numbers.
    The two values must be integers.
Help on function printMax in module __main__:

printMax(x, y)
    Prints the maximum of two numbers.
    The two values must be integers.
这个函数主要用于显示你在程序中用三个单引号引起来的对这个函数说明的文档和帮助文档。

小甲鱼

福禄娃娃 发表于 2013-9-25 15:43

                               
登录/注册后可看大图

Python有一个很奇妙的特性，称为 文档字符串 ，它通常被简称为 docstrings 。DocStrings是一个重要的工具， ...

娃娃回复好快~

福禄娃娃

小甲鱼 发表于 2013-9-27 02:33

                               
登录/注册后可看大图

娃娃回复好快~

帮助鱼油是应该的，自己也能学习下
后来又查了下原来docstrings就是三重引号的意思，还可以进行多行注释。

怡静

福禄娃娃 发表于 2013-9-25 15:43

                               
登录/注册后可看大图

Python有一个很奇妙的特性，称为 文档字符串 ，它通常被简称为 docstrings 。DocStrings是一个重要的工具， ...

娃娃真的很用心在学，不错！