python学习手册笔记——15.文档

00.这是和工具相关的概念，但这个主题会在这里介绍有两个原因，一是它设计了Python的语法模型，而是它是哪些努力项了解Python工具集的读者的资源。

01.Python预置的功能数量惊人：内置函数和异常、预先定义的对象属性和方法、标准库模块等。

02.Python文档资源
#注释 文件中的文档
dir函数 对象中可用属性的列表
文档字符串:__doc__ 附加在对象上的文件中的文档
PyDoc:help函数 对象的交互帮助
PyDoc:HTML报表 浏览器中的模块文档
标准手册 正式的语言和库的说明
网站资源 在线教程、例子等
出版的书籍 商业参考书籍

03.实际上，当前最佳的实践经验通常都表明，文档字符串最适于较大型的文档，而#注释最适用于较小功能的文档。

04.dir函数：内置的dir函数时抓取对象内可用所有属性列表的简单方式。它能够调用任何有属性的对象。dir函数可作为记忆提醒器，提供属性名称的列表，但并没有告诉哪些名臣的意义是什么。

 

05.这个文档协议的重点在于，注释会保存在__doc__属性中以供查看(文件导入之后)。因此，要显示这个模块以及其对项打算关联的文档字符串，我们只需要导入这个文件，简单的打印在__doc__属性。

06.文档在程序猿之间的优先级都偏低。而一般情况下，如果你看到文件中任何注释，那都已经算幸运了。不过，本书强烈建议你详细为代码编写文档，者其实是写好代码的重要部分。这里的重点就是，目前文档字符串的结构没有标准。

07.常见编写代码的陷阱
*别忘了冒号
*从第1行开始
*空白行在交互模式提示符下很重要
*缩进要一致
*不要再Python中写C代码
*使用简单的for循环，而不是while或range。
*要注意赋值语句中的可变对象
*不要期待再原处修改对象的函数会返回结果
*一定要使用括号调用函数
*不要再导入和重载中使用扩展名或路径