首页 最新 热门 推荐

  • 首页
  • 最新
  • 热门
  • 推荐

第8.19节 使用__doc__访问Python文档字符串(DocStrings )

  • 23-09-22 19:02
  • 4422
  • 13270
blog.csdn.net

__doc__特殊变量用于查看类、函数、模块的帮助信息,这些帮助信息存放在文档字符串中。
一、 关于文档字符串
关于文档字符串前面很多章节提到过,DocStrings 文档字符串用于程序的文档说明,并作为程序的一部分嵌入代码中,使得帮助信息成为程序的一部分 ,帮助程序文档更加简单易懂,且使用维护方便。
文档字符串是使用一对三个单引号 ‘’’ 或者一对三个双引号 “”"来包围且没有赋值给变量的一段文字说明(如果是单行且本身不含引号,也可以是单引号和双引号), 它在代码执行时会被忽略,但会被解释器识别并放入所在类、函数或模块的 doc 属性中。文档字符串通常用于如下几个方面:

  1. 模块开头,作为整个模块的文档说明;
  2. 函数/方法的def语句定义后到函数体之间,用于函数/方法说明;
  3. 类定义的class语句后到类体之间,用于类说明。
    Python推荐的文档字符串格式为:
    文档字符串是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。文档字符串两个三引号的缩进必须与代码的缩进策略一样。

二、 使用__doc__访问文档字符串
可以使用 “类名.doc”、“函数名.doc”、“模块名.doc”查看类、函数、模块的文档字符串,查看时要确认相关定义都已经执行或加载。
三、 案例
在这里插入图片描述
注意黄色标记部分,前面两个是缩进,后面是说明repr和str的输出的差异,具体参考《第8.17节 Python __repr__方法和__str__方法、内置函数repr和str的异同点对比剖析》。

本节介绍了Python文档字符串的定义和使用以及访问方法,文档字符串是一个非常好用的帮助文档手段,非常符合Python风格。请大家遵守文档字符串的定义惯例。

老猿Python,跟老猿学Python!
博客地址:http://iyenn.com/index/link?url=https://blog.csdn.net/LaoYuanPython

欢迎大家点赞、评论和加关注!

文章知识点与官方知识档案匹配,可进一步学习相关知识
Python入门技能树基础语法数据类型333596 人正在系统学习中
老猿Python
微信公众号
专注Python相关语言、图像音视频处理、AI
注:本文转载自blog.csdn.net的LaoYuanPython的文章"https://blog.csdn.net/LaoYuanPython/article/details/94748579"。版权归原作者所有,此博客不拥有其著作权,亦不承担相应法律责任。如有侵权,请联系我们删除。
复制链接
复制链接
相关推荐
发表评论
登录后才能发表评论和回复 注册

/ 登录

评论记录:

未查询到任何数据!
回复评论:

分类栏目

后端 (14832) 前端 (14280) 移动开发 (3760) 编程语言 (3851) Java (3904) Python (3298) 人工智能 (10119) AIGC (2810) 大数据 (3499) 数据库 (3945) 数据结构与算法 (3757) 音视频 (2669) 云原生 (3145) 云平台 (2965) 前沿技术 (2993) 开源 (2160) 小程序 (2860) 运维 (2533) 服务器 (2698) 操作系统 (2325) 硬件开发 (2492) 嵌入式 (2955) 微软技术 (2769) 软件工程 (2056) 测试 (2865) 网络空间安全 (2948) 网络与通信 (2797) 用户体验设计 (2592) 学习和成长 (2593) 搜索 (2744) 开发工具 (7108) 游戏 (2829) HarmonyOS (2935) 区块链 (2782) 数学 (3112) 3C硬件 (2759) 资讯 (2909) Android (4709) iOS (1850) 代码人生 (3043) 阅读 (2841)

热门文章

101
推荐
关于我们 隐私政策 免责声明 联系我们
Copyright © 2020-2024 蚁人论坛 (iYenn.com) All Rights Reserved.
Scroll to Top