python核心编程

文档字符串：应该多用，help（）的作用就是把builtin的函数的文档字符串取出然后打印出来。。。

 1  #! /usr/bin/python
  2 def printmax(a,b):
  3         '''print max of two  int numbers'''
  4         x = int(a)
  5         y = int(b)
  6         if x>y:
  7                 print x,'max'
  8         else :
  9                 print y,'max'
 10 printmax(3,5)
 11 print(printmax.__doc__)

注意def下面的缩进是必须的，doc前后的下划线各为2个。

它如何工作

在函数的第一个逻辑行的字符串是这个函数的 文档字符串 。

文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。

你可以使用__doc__（注意双下划线）调用printMax函数的文档字符串属性（属于函数的名称）。请记住Python把每一样东西 都作为对象，包括这个函数。

如果你已经在Python中使用过help()，那么你已经看到过DocStings的使用了！它所做的只是抓取函数的__doc__属性，然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。

自动化工具也可以以同样的方式从你的程序中提取文档。因此，我 强烈建议 你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令，与help()类似地使用DocStrings。