Python 中文文档

Python014

Python 中文文档,第1张

Python标准库中文版:http://tieba.baidu.com/f?kz=801447402

python 的教程我自己收集了上百M

市面也有一些中文版的书

楼主也应该学一学英语,将来自己能看英文文档还是很好的。

.通用实践推荐只在有关表达式、语句或一小组语句的小型文档中使用井号注释。文档字符串更适用于文件、函数或类中的更高级、更广阔的功能型文档,并且已经成为Python软件预期的一部分。除了这些守则,你还需要自行决定文档的内容。

尽管一些公司有内部标准,但关于文档字符串的文本应该包含些什么,其实并没有普适的标准。目前已经有许多标记语言和模板协议(例如,HTML或XML),但它们似乎都没有在Python世界中流行起来。坦率地讲,要让程序员手动编写HTML来为代码添加文档,基本上是天方夜谭。要求编写HTML格式的注释不仅看上去是无理取闹,而且通常也不符合文档编写的惯例。

一些程序员并没有给予文档应有的重视。很多情况下,如果你阅读的源代码有一丝注释,那都算非常走运了(且不说那些注释是否有被及时更新)。不过,强烈建议详细地为代码编写文档,因为这是写好代码很重要的步骤。不过,目前确实没有关于文档字符串结构的标准,如果想要编写文档,那么在今天一切内容都是可接受的。就像编写代码本身一样,你可以自行决定是否创建文档内容并及时更新,当然你最好使用常识来加以判断。