`
禹爸爸
  • 浏览: 85877 次
  • 性别: Icon_minigender_1
  • 来自: 苏州
社区版块
存档分类
最新评论

Python随笔之文档字符串(DocStrings)

阅读更多

在Python中有一个奇妙的特性,文档字符串,又称为DocStrings。用它可以为我们的模块,类,函数添加说明性的文字,使程序易读易懂,更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。下面举例说明。

 

'''This is My own Module

Date:2011-09-07
Author:Chris Mao

This is description information'''

class TestClass:
    '''This is TestClass' DocStrings'''
    def func1():
        '''this is func1's DocStrings'''
        pass

def func2():
    '''this is func2'''
    print "this is func2"

print func2.__doc__

 

版权声明:本文为博主原创文章,未经博主允许不得转载。

分享到:
评论

相关推荐

    python文档字符串(函数使用说明)使用详解

    Python中的文档字符串(docstrings)是用于记录函数、类或模块功能、用法及作者等信息的特殊字符串。它们在程序执行时可被用来生成帮助和文档,是Python代码可读性和可维护性的重要组成部分。下面我们将深入探讨文档...

    nim-docstrings:用 Nim 编程语言编写的类似 Python 的文档字符串

    用编写的类似 Python 的文档字符串。 介绍 该模块实现了 Python 风格的 docstrings,可以嵌入到 proc 的源代码中,以及一些简单的 procs 和宏,使这些 docstrings 能够在编译时被 pragma 提取。 这些文档字符串用于...

    canllaw:降价的python文档字符串

    在Python中,文档字符串(docstrings)是一种用于记录模块、类、函数或方法详细信息的特殊字符串,它们在代码中常以三引号括起来。这些字符串在程序运行时可以通过内置的`__doc__`属性访问,为用户提供方便的API文档...

    pyment:格式化和转换Python文档字符串并生成补丁

    "pyment" 是一个工具,它的主要功能是处理 Python 代码中的文档字符串(docstrings),对其进行格式化和转换,并且能够生成补丁。这表明它可能用于帮助开发者保持代码库中文档的一致性和完整性,尤其是对于那些遵循...

    ai-docstring:Visual Studio Code扩展,可使用AI(NLP)技术为python函数快速生成文档字符串

    VSCode Python AI文档字符串生成器Visual Studio Code扩展,可使用AI(NLP)技术为python函数快速生成文档字符串。 该项目是为分叉的。 以前,功能描述必须由用户编写,但AI会看到代码并进行总结。产品特点AI快速...

    pydoc:适用于Python的文档字符串

    1. **文档字符串(docstrings)**:Python中,docstrings是在函数、类或模块的开头定义的三引号字符串,用于提供该对象的说明。pydoc模块通过读取这些docstrings来生成文档。 2. **pydoc的使用**:使用`pydoc`命令...

    vim-pydocstring:生成Python文档字符串到您的Python源代码

    `vim-pydocstring` 是一个 Vim 插件,它为 Python 开发者提供了一种方便的方式来自动插入或更新源代码中的文档字符串(docstrings)。这个插件是 Vim 和 VimScript 的结合,使得在 Vim 编辑器内编写 Python 代码时,...

    Python-CoreDocs一个API文档生成器

    在Python中,docstrings是嵌入在函数、类或模块内的三引号字符串,用来解释代码的功能和用法。CoreDocs读取这些docstrings,结合模块、类和函数的定义,生成相应的文档页面。 ### 安装与使用 安装CoreDocs通常通过...

    python 3.8.3 中文文档

    最后,Python 3.8对文档字符串(docstrings)进行了规范化,现在推荐使用三引号包裹单行或多行字符串,以提高可读性和一致性。 总的来说,Python 3.8.3版本的更新不仅带来了语言层面的改进,也强化了标准库的功能,...

    custom_inherit:一个Python软件包,提供了以可自定义方式继承文档字符串的工具

    内置的文档字符串合并样式,用于流行的文档字符串规范: NumPy文档字符串规范拿破仑文档字符串规范(适用于Google和NumPy样式) 根据reST部分合并如果未覆盖文档字符串,则从父级进行简单继承( Python 3.5中已弃用...

    Python知识点详细总结.pdf

    字符串是Python中最常用的数据类型之一,掌握好字符串的操作对于编写高效、易读的代码至关重要。 - **多行字符串**:使用三个单引号(`'''`)或三个双引号(`"""`)可以定义多行字符串。这种类型的字符串允许在其中...

    Python总结(精简).pdf

    4. **文档字符串**:文档字符串(Docstrings)是函数、类或模块的第一行,用于描述该对象的目的和用法。一个好的实践是在每个公共函数和类上使用文档字符串。文档字符串应放在三个引号之间,并且首行应当包含关于...

    Python库 | polarion_docstrings-0.13-py2.py3-none-any.whl

    资源分类:Python库 所属语言:Python 资源全名:polarion_docstrings-0.13-py2.py3-none-any.whl 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059

    python编程规范

    - 文档字符串(docstrings)是模块、函数、类或方法的特殊字符串,用于解释其用途和使用方法。 ### 版本标记 PEP 8建议使用__version__变量来表示版本号,并在模块的文档字符串中更新此信息。 ### 命名约定 命名...

    Python中如何添加注释共2页.pdf.zip

    3. 文档字符串(docstrings): Python中的文档字符串是特殊的多行注释,它们用于为函数、类或模块提供文档。文档字符串通常放置在定义的开头,用三个双引号包围: ``` def my_function(param1, param2): """这...

    Atom-docblock-python,插入python函数文档块的atom插件.zip

    在Python编程中,良好的文档注释是项目可读性和维护性的重要保障,docstring(文档字符串)是Python中用于提供函数、类或模块文档的标准方式。Atom-docblock-python插件则简化了这一过程,它能够自动生成符合PEP 257...

    Python开发编码规范.pdf

    文档字符串(docstrings)是Python代码中用来描述函数、类或模块用途的特殊字符串。它们通常放在对象定义的开头,遵循特定格式,如三引号包围,对于长字符串,可以跨多行书写,确保不超过72个字符。 编码方面,...

    python单引号_双引号和三引号的区别.docx

    这种类型的字符串可以跨越多行,非常适合用于创建文档字符串(docstrings)或者存储多行文本。 **2. 示例** - **示例1**: ```python s5 = """hello, world, hahaha.""" print(s5) ``` - **输出结果**: ```...

    Python总结精简.docx

    对于函数和类,应使用文档字符串(DocStrings),它是多行字符串,通常用三个单引号(''')或三个双引号(""")包裹。文档字符串的第一行应简洁地概述对象的用途,接下来的行应空出,然后是详细的描述。 5. **操作...

Global site tag (gtag.js) - Google Analytics