`

Python学习笔记(四)DocStrings

 
阅读更多
#!/usr/bin/python
# Filename: func_doc.py

def printMax(x, y):
    '''Prints the maximum of two numbers.

    The two values must be integers.'''
    x = int(x) # convert to integers, if possible
    y = int(y)

    if x > y:
        print x, 'is maximum'
    else:
        print y, 'is maximum'

printMax(3, 5)
print [b]printMax.__doc__[/b]


它所做的只是抓取函数的__doc__属性,然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。
分享到:
评论

相关推荐

    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程序员面试宝典基础版

    Q32、什么是Python中的文档Docstrings? Docstrings实际上不是注释,它们是文档字符串。这些文档字符串在三引号内。它们没有分配给任何变量,因此有时也用于注释。 Q33、operators中的is、not和in各有什么功能? ...

    简明python代码规范.doc

    业界普遍认同 Python 的注释分为两种的概念,一种是由 # 开头的“真正的”注释,另一种是 docstrings。前者表明为何选择当前实现以及这种实现的原理和难点,后者表明如何使用这个包、模块、类、函数(方法),甚至...

    简明python教程(chm)

    16. 接下来学习什么? 图形软件 GUI工具概括 探索更多内容 概括 A. 自由/开放源码软件(FLOSS) B. 关于本书 后记 关于作者 关于译者 关于简体中文译本 C. 修订记录 时间表 术语表 表格 5.1 运算符...

    Python自动补齐和静态分析工具Jedi.zip

    Jedi 理解 docstrings,你也可以在你的 REPL 中使用 Jedi 自动补齐完成。Jedi 使用一个非常简单的 API 来连接 IDE,能支持以下编辑器/项目:Vim Emacs Sublime TextTextMateKateAtomSourceLairGNOME ...

    简明python教程

    16. 接下来学习什么? 图形软件 GUI工具概括 探索更多内容 概括 A. 自由/开放源码软件(FLOSS) B. 关于本书 后记 关于作者 关于译者 关于简体中文译本 C. 修订记录 时间表 术语表 表格 5.1 运算符与...

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

    该模块实现了 Python 风格的 docstrings,可以嵌入到 proc 的源代码中,以及一些简单的 procs 和宏,使这些 docstrings 能够在编译时被 pragma 提取。 这些文档字符串用于从记录的过程中自动提取内省文档。 这是 ...

    python简明教程.chm

    16. 接下来学习什么? 图形软件 GUI工具概括 探索更多内容 概括 A. 自由/开放源码软件(FLOSS) B. 关于本书 后记 关于作者 关于译者 关于简体中文译本 C. 修订记录 时间表 术语表 表格 5.1 运算符...

    简明 Python 教程.rar

    无论您刚接触电脑还是一个有经验的程序员,本书都将有助您学习使用Python语言。 目 录 前言.1 本书的读者..........1 本书的由来..........1 本书目前的状况...2 约定条款..2 反馈.........2 值得思考的...

    Python中文手册

    解决问题——编写一个Python脚本 <br>问题 <br>解决方案 <br> 版本一 <br> 版本二 <br> 版本三 <br> 版本四 <br> 进一步优化 <br>软件开发过程 <br>概括 <br>11....

    Python简明教程

    一个不错的Python入门教程... ...16. 接下来学习什么? 图形软件 GUI工具概括 探索更多内容 概括 A. 自由/开放源码软件(FLOSS) B. 关于本书 后记 关于作者 关于译者 关于简体中文译本 C. 修订记录 时间表 术语表

    a_byte_of_python

    this is a book about python. it was written by Swaroop C H.its name is "a byte of python". Table of Contents Preface Who This Book Is For History Lesson Status of the book Official Website ...

    sublime_docblockr_python:Sublime Text DocBlockr适用于python。 简化用Python编写文档字符串注释的过程

    DocBlockr适用于Python 基于项目,此扩展提供类似的功能,但适用于python docstrings。 该插件的默认格式化程序是围绕规范设计的,但具有更多的冗长性:添加了变量类型,列出了类扩展名和列出了装饰器。 该项目的...

    glacier:使用docstrings和typehints构建Python CLI

    glacier是面向极简主义者的python CLI构建库。 安装 pip install glacier 快速开始 您只需要针对入口点函数调用glacier 。 from glacier import glacier def main ( name : str , verbose : bool = False ) -> None...

    GIFT-Grab:开源的C ++和Python API,用于实时获取,处理和编码视频流。 支持多个帧采集卡,符合标准的网络流和视频文件。 Python API与NumPy和SciPy兼容-python source file

    礼物抢 GIFT-Grab是一个开源C ++和Python API,用于实时获取,处理和编码视频流。 GIFT-Grab支持多种帧采集卡,符合标准的网络流和视频文件。... C ++ docstrings中记录了差异(例如)。 引用GIFT-Grab 如果您在工

    PyPI 官网下载 | polarion-docstrings-0.22.0.tar.gz

    资源来自pypi官网。 资源全名:polarion-docstrings-0.22.0.tar.gz

    fastly-py:快速Python客户端

    purge_url ( 'www.example.com' , '/some/path' )去做: 文件档案Docstrings 配置文件运行测试 $ python -m test.api_test设置环境配置我们使用Python的和.env文件来管理开发和测试环境中的环境变量。 请参阅根目录...

    python-deep-dive:一些用python编写的示例和代码,用于教学目的

    python-dive-dive 一些用python编写的示例和代码,用于教学目的 语句。 :有关函数的基本知识。... :命名的元组docstrings和默认值。 :命名元组应用程序-返回多个值。 :命名元组应用程序-词典的替代方法。

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

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

Global site tag (gtag.js) - Google Analytics