在语言要求的地方注释,以标准的注释语法。
注释说明必要的信息,
适当的设计思路描述
适当的算法设计描述


文档化的工具:
    1. epydoc:
        纯Python实现。
        与Python的结合非常自然,稳定,可扩展。
       
    2. DoxyGen.
   
epydoc标签规范:
    1. py文献信息:
        @author:   ...作者
        @license:  ...版权
        @contact:  ...联系
       
    2. py状态信息:
        @version:  ...版本推荐使用$Id$
        @todo[ver]:...改进,可以指定针对的版本
       
    3. py模块信息:
        @var v: ...模块变量v说明
        @type v: ...模块变量类型v说明
       
    4. py函数信息:
        @param p: ...参数p说明
        @type p: ...参数p类型说明
        @return: ...返回值说明
        @rtype: ...返回值类型说明
       
    5. py提醒信息:
        @note: ...注解
        @attention: ...注意
        @bug: ... 问题
        @warning: ...警告
       
    6. py关联信息:
        @see: ...参考资料
       
    7. py注释风格:

 1#xxxx.py文件模板
 2'''
 3@version: $Id$
 4@author: U{username<mailto: email_address>}
 5@see: 资料
 6'''
 7
 8import sys, os, other
 9
10class Templates(object):
11    '''
12    类说明
13    '''
14    def __init__(self, param1):
15        '''
16        @param param1: 注释内容。
17         @type param1: 介绍。
18         @return: 返回简介。
19         @rtype v: 返回类型简介。
20         '''
21        self.param1 = param1

    8. 特殊标签:
        U{text<url>}: URL
        L{text<object>}:交叉引用,自动生成到其他对象的文档页面链接。
                                      object为对象名称, 类/函数/变量名