第8.19节 使用__doc__访问Python文档字符串（DocStrings ）
2024-10-20 16:08:05
__doc__特殊变量用于查看类、函数、模块的帮助信息，这些帮助信息存放在文档字符串中。
一、 关于文档字符串
关于文档字符串前面很多章节提到过，DocStrings 文档字符串用于程序的文档说明，并作为程序的一部分嵌入代码中，使得帮助信息成为程序的一部分 ，帮助程序文档更加简单易懂，且使用维护方便。
文档字符串是使用一对三个单引号 ‘’’ 或者一对三个双引号 “”"来包围且没有赋值给变量的一段文字说明（如果是单行且本身不含引号，也可以是单引号和双引号）， 它在代码执行时会被忽略，但会被解释器识别并放入所在类、函数或模块的 doc 属性中。文档字符串通常用于如下几个方面：
- 模块开头，作为整个模块的文档说明；
- 函数/方法的def语句定义后到函数体之间，用于函数/方法说明；
- 类定义的class语句后到类体之间，用于类说明。
Python推荐的文档字符串格式为：
文档字符串是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。文档字符串两个三引号的缩进必须与代码的缩进策略一样。
二、 使用__doc__访问文档字符串
可以使用 “类名.doc”、“函数名.doc”、“模块名.doc”查看类、函数、模块的文档字符串，查看时要确认相关定义都已经执行或加载。
三、 案例
注意黄色标记部分，前面两个是缩进，后面是说明repr和str的输出的差异，具体参考《第8.17节 Python __repr__方法和__str__方法、内置函数repr和str的异同点对比剖析》。
本节介绍了Python文档字符串的定义和使用以及访问方法，文档字符串是一个非常好用的帮助文档手段，非常符合Python风格。请大家遵守文档字符串的定义惯例。
老猿Python，跟老猿学Python!
博客地址：https://blog.csdn.net/LaoYuanPython
欢迎大家点赞、评论和加关注！
最新文章
- ajax是什么
- Openwrt Uboot烧写
- VIM替换、截取及追加操作
- memcached学习（3）memcached的删除机制和发展方向
- 【 D3.js 选择集与数据详解 — 2 】 使用data()绑定数据
- 讲解版的自动轮播（新手福利）样式和js就不分离了为了看的方便
- 被sjy带刷题#1
- delphi高手突破学习笔记之面向对象类和对象的本质（有汇编解释 good）
- 在线协作沟通工具DesignBoard帮助设计团队更有效地进行沟通与版本管理
- 算法训练 K好数
- Java的一些良好习惯及细节------持续更新中...
- 11_Eclipse中演示Git版本的创建，历史版本的修改，创建分支，合并历史版本和当前版本
- win10 64位 安装scrapy
- K8S学习笔记之CentOS7集群使用Chrony实现时间同步
- SpringCloud中eureka配置心跳和剔除下线的服务的时间
- iOS开发-- 如何让 UITableView 的 headerView跟随 cell一起滚动
- Thinkphp自动验证规则
- bzoj 4402 Claris的剑 组合数学
- CF835F Roads in the Kingdom
- python学习总结---函数使用 and 装饰器