学习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_root if _kos_root: return _kos_root
在一个模块之中docstring文档字符串也是必须要的，它要写在python模块文件的最开始位置，并且需要顶格写，示例如下：
"""A one Leave one blank line """
在代码中编写docstring文档字符串的时候，需要把它视为和其他一样，因为它也需要按照代码缩进的语法规则空出空格。
以上就是关于“Python中docstring是什么意思？Python中docstring有什么用”的全部内容了，希望对你有所帮助。
更多python相关文章请访问分类：python
【版权声明】本文图文出自大盘站@dapan.cc，转载请注明出处！
声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。
