python编写代码文档
应用开发的另一个重要的方面就是----编辑文档且符合编码标准。
如果被分配到一个项目上有大量的代码，如果其没有很好的说明文档，你的生产力会收到影响，理解代码上的时间也较多。
维护文档也同样重要，但不要过度文档化。
文档大致分为三层：
1.最外层文档。提供项目高层次信息，如安装说明，许可条款等。例如（README，LICENSE）文件等。
2.API文档。用于介绍函数，方法，类，模块的说明文字。
3.代码注释。注释用于解释一段代码是如何工作的。
Sphinx是一个python用来创建最外层文档和API文档的生成工具。
python文档字符串是指：用三个双引号包围的，位于类或方法或函数或模块的第一行声明。如下代码：
def get_number(): ... """这是文档字符串部分，说明此函数功能""" ... return 10 ... get_number.__doc__ \'这是文档字符串部分，说明此函数功能\'
通过黄色标注的__doc__,显示出了get_number函数的文档字符串。
RST格式文档是什么？----reStructuredText，轻量标记语言，被设计为容易阅读和编写的纯文本,并且可以借助Docutils这样的程序进行文档处理,也可以转换为HTML或PDF等多种格式。
RST可以用任意~~~~~~~~~~,..................,----------,#######等分割线将标语于段落等分割开。注意长度即可。可以使用在线RST编辑器来编辑测试。
在RST中*text*以斜体风格显示，**text**以粗体显示。
RST语法需要在不同风格的块之间留空行。
当源程序使用RST文档字符串按其语法标注好后，即可借助Sphinx工具自动生成HTML格式说明文档。具体语法查阅资料。
借助IDE，可以方便的规范化python源代码，如果想进一步分析测试代码的规范，可以借助Pylint模块，其可以检查代码中的错误以及违反标准的行为，并评分。