`

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读书笔记

    DocStrings 是 Python 中的一种文档字符串。它可以用于函数、模块和类的文档。DocStrings 是一个多行字符串,首行以大写字母开始,句号结束,第二行为空,第三行开始详细的描述。 模块 ------ 模块是 Python 中的...

    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学习(英文版)

    在“Comments and Documentation”章节中,作者详细说明了如何在Python代码中添加单行、内联和多行注释,并展示了如何程序化地访问和使用文档字符串(docstrings)来编写文档。接着,“Date and Time”章节提供了...

    python研究笔记

    #### 四、文档字符串(Docstrings) 9. **函数文档字符串**:通常情况下,Python的函数、类或模块的第一个逻辑行会包含一个由三个单引号或双引号包围的字符串,这个字符串被称为文档字符串(Docstring)。文档字符串...

    Doc_python_源码

    通过阅读和理解这些源文件,我们可以学习如何编写清晰的docstrings,如何组织和格式化文档,以及如何利用Sphinx进行自动化文档生成。这对于提升个人或团队的开发效率和代码质量大有裨益。同时,了解Python官方文档的...

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

    "PyPI 官网下载 | polarion-docstrings-0.22.0.tar.gz" 这个标题提及的是一个从Python Package Index (PyPI) 官方网站获取的压缩包文件,名为 "polarion-docstrings-0.22.0.tar.gz"。PyPI是Python开发者发布和分享...

    python学习手册

    ### Python学习手册:掌握编程语言的关键特性与应用 #### 引言 《Python学习手册》是一本详尽的指南,旨在帮助读者深入了解Python这门强大的编程语言。本书不仅覆盖了Python的基础知识,还深入探讨了其高级特性,...

    Python-CoreDocs一个API文档生成器

    它通过解析Python源代码中的docstrings(注释)和其他元数据,自动构建出结构清晰、易于阅读的文档。 ### CoreDocs 的工作原理 CoreDocs的核心功能在于它能够理解Python代码的结构和注释。在Python中,docstrings...

    Python图书管理系统源码.zip

    总的来说,《Python图书管理系统源码》涉及到Python编程、GUI设计、数据库操作、异常处理、设计模式等多个方面,是学习和实践Python全栈开发的好案例。通过分析和理解这个系统,开发者可以提升自己在实际项目中的...

    A Byte of Python3(中文版)

    其内容涵盖了从Python简介、安装指南、基础语法到数据结构、模块使用、面向对象编程等,适合初学者作为学习指南,也能够为计算机相关的从业人员提供参考资料。 书中不仅介绍了Python的基本概念,如字面量、操作符、...

    PEP8Python 编码规范

    2. 文档字符串(Docstrings):文档字符串用于解释模块、类、方法和函数的功能。PEP8规定文档字符串的格式应当遵循PEP257的约定,而且应该简洁明了。 3. 缩进和空格:Python使用缩进来表示代码块,而PEP8中提到,...

    python学习记录(函数)

    ### Python函数学习要点 #### 函数基础概念 在Python中,函数是一段可重用的代码块,它有助于实现特定功能并能多次调用而无需重新编写相同的代码。使用`def`关键字定义函数,例如: ```python def say_hello(): ...

    PythonCodingRule.pdf

    1. Python入门基础:文档提到了“无私分享,用于Python的入门学习”,意味着文档提供了初学者如何开始学习Python编程的基础知识和示例。 2. 基本语法规范:文档中提到了“讲解了Python的一些基本用法、语法规范等...

    A byte of Python

    《A Byte of Python》是一本非常受欢迎的Python编程入门书籍,适用于想要学习Python编程的初学者以及希望进一步提升自己编程技能的计算机专业人士。本书由Swaroop C. H.撰写,并由Letitbe进行了中文翻译。本书最新...

    python-distilled-developers-library.rar

    9. **编码规范与文档编写**:良好的编码风格和详尽的文档对于团队协作至关重要,PEP8是Python的官方编码规范,书中有望介绍如何遵循这些规则,并使用docstrings和Sphinx生成高质量的项目文档。 10. **实践案例分析*...

    Python的基础语法

    它允许程序员通过命令行或者直接在代码中执行程序,因此,对于初学者来说,Python是一种易于学习和使用的语言。 Python的标识符用于区分变量、函数、类等实体,是由字母、数字和下划线组成,但不能以数字开头,且...

Global site tag (gtag.js) - Google Analytics