文档字符串

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__

 

1. 文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开 始是详细的描述。

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

3. 如果你已经在Python中使用过help()，那么你已经看到过DocStings的使用了！它所做的只是抓取函数 的__doc__属性，然后整洁地展示给你。

你可以对上面这个函数尝试一下——只是在你的程序中包 括help(printMax)。记住按q退出help。 自动化工具也可以以同样的方式从你的程序中提取文档。因此，我 强烈建议 你对你所写的任何正式函数编 写文档字符串。随你的Python发行版附带的pydoc命令，与help()类似地使用DocStrings。

 

备注：

1. 如何退出Python提示符：如果你使用的是Linux/BSD shell，那么按Ctrl-d退出提示符。如果是在Windows命令行 中，则按Ctrl-z再按Enter。

2. 如果你想要指示某些不需要如转义符那样的特别处理的字符串，那么你需要指定一个自然字符串。

    自然字符串通过给字符串加上前缀r或R来指定。例如r"Newlines are indicated by\n"。一定要用自然字符串处理正则表达式。否则会需要使用很多的反斜杠。例如，后向引用 符可以写成'\\1'或r'\1'。

Python的特点：

1. 在 面向过程 的语言中，程序是由过程或仅仅是可重用代码的函数构建起来的。在 面向对象 的语言中，程序是由数据和功能组合而成的对象构建起来的。

2.  解释性：

一个用编译性语言比如C或C++写的程序可以从源文件（即C或C++语言）转换到一个你的计算机使用的语言（二进制代码，即0和1）。这个过程通过编译器和不同的标记、选项完成。当你运行你的程序的时候，连接/转载器软件把你的程序从硬盘复制到内存中并且运行。

而Python语言写的程序不需要编译成二进制代码。你可以直接从源代码 运行 程序。在计算机内部，Python解释器把源代码转换成称为字节码的中间形式，然后再把它翻译成计算机使用的机器语言并运行。事实上，由于你不再需要担心如何编译程序，如何确保连接转载正确的库等等，所有这一切使得使用Python更加简单。由于你只需要把你的Python程序拷贝到另外一台计算机上，它就可以工作了，这也使得你的Python程序更加易于移植。

3. 可扩展性

如果你需要你的一段关键代码运行得更快或者希望某些算法不公开，你可以把你的部分程序用C或C++编写，然后在你的Python程序中使用它们。

4.可嵌入性
你可以把Python嵌入你的C/C++程序，从而向你的程序用户提供脚本功能。

5. 丰富的库
Python标准库确实很庞大。它可以帮助你处理各种工作，包括正则表达式、文档生成、单元测试、线程、数据库、网页浏览器、CGI、FTP、电子邮件、XML、XML-RPC、HTML、WAV文件、密码系统、GUI（图形用户界面）、Tk和其他与系统有关的操作。记住，只要安装了Python，所有这些功能都是可用的。这被称作Python的“功能齐全”理念。

除了标准库以外，还有许多其他高质量的库，如wxPython、 Twisted和Python图像库等等。