python程序中在线文档编辑

编写一个测试模块
[root@localhost bin]# vim start.py
#!/usr/bin/env python
#coding: utf8                           //告诉程序支持中文
"""测试程序                            //帮助标题

仅包含一个函数"""                  //帮助主体

def pstar():                              //定义函数
    "定义函数，用于输出50个*"                     //定义该函数的帮助信息
    print '*' * 50


导入测试模块
[root@localhost bin]# python
Python 2.6.6 (r266:84292, Nov 22 2013, 12:16:22) 
[GCC 4.4.7 20120313 (Red Hat 4.4.7-4)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import tab
>>> import start

查看帮助信息，可以看到信息是脚本中定义的值
>>> help(start)
Help on module start:

NAME
    start - 测试程序

FILE
    /opt/bin/start.py

DESCRIPTION
    仅包含一个函数

FUNCTIONS
    pstar()
        定义函数，用于输出50个*