学习python的小伙伴都知道python是一个简洁的编程语言，而它简洁的这个特点实际上是由几个PEP规范组成的，只有遵守了这些规范的python程序才是简介合格的 。而在这些规范之中有一个叫做文档字符串，也就是docstring，下面对其会有详细的介绍 。
文章插图
docstring在python之中叫做文档字符串或者是说明文档，它既是PEP257文档字符串规范，也是一种代码编写时的语法 。docstring简单来说就是一个在函数、类型、方法、模块定义时写在代码第一行的注释 。虽然它在代码中的表现形式为注释，但是它实际上会被python解析器视为该对象的__doc__属性 。
根据python编码规范，所有具有代码块的结构在定义时都需要有一个docstring，它使用来描述并且解释这一个对象功能的提示信息 。其中类、函数、方法之中的docstring在定义时只能够写在定义语法的下面一行，并且要使用三引号包括起来，示例如下：
def kos_root(): """Return the pathname of the KOS root directory.""" global _kos_rootif _kos_root: return _kos_root在一个模块之中docstring文档字符串也是必须要的，它要写在python模块文件的最开始位置，并且需要顶格写，示例如下：
"""A oneLeave one blank line"""在代码中编写docstring文档字符串的时候，需要把它视为和其他一样，因为它也需要按照代码缩进的语法规则空出空格 。
【Python中docstring是什么意思？Python中docstring有什么用】以上就是关于“Python中docstring是什么意思？Python中docstring有什么用”的全部内容了，希望对你有所帮助 。
推荐阅读
- 淘宝年中大促活动时间是多久？商品申报要求是什么？
- PPT中幻灯片怎么插入特殊形状？PPT中幻灯片插入特殊形状的方法
- PPT中如何设置章节？PPT中设置章节的方法
- ppt中怎么精确调整图形位置？ppt中精确调整图形位置的方法
- ppt中怎么设计出食物宣传海报？ppt设计出食物宣传海报的方法
- 木棉花花语和木棉花的寓意
- PPT中怎么添加毛笔字体？PPT中添加毛笔字体的方法
- PPT中怎么制作出手绘圣诞快乐圣诞卡？PPT中制作出手绘圣诞快乐圣诞卡的方法
- ppt中怎么设计环形图片排版？ppt设计环形图片排版的方法
- ppt中怎么制作出浆形图形设计？ppt中制作出浆形图形设计的方法