`

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

    《Python编程金典》读书笔记

    ### 《Python编程金典》读书笔记知识点梳理 #### 1. 绪论 绪论部分通常会介绍Python的历史背景、特点以及为什么选择Python作为学习和使用的编程语言。此外,还会涉及Python与其他编程语言的区别,以及它在不同领域...

    python-study:python学习成长记录

    在"python-study-main"这个目录中,我们可以期待找到与Python学习相关的各种内容。这可能包括: 1. **基础语法**:Python的基础包括变量、数据类型(如整型、浮点型、字符串、列表、元组、字典)、控制流(if-else...

    Python库 | sphinx-autoapi-0.3.0.tar.gz

    - 个人学习:梳理自己的学习项目,快速生成教程和笔记。 ### 示例配置 在`conf.py`中,你可以这样配置`sphinx-autoapi`: ```python extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_...

    softuni_python

    这个压缩包中的主要文件名为 "softuni_python-main",这可能是一个包含源代码、笔记或者其他学习材料的主目录。 在Python编程领域,学习资源通常包括以下部分: 1. **基础语法**:Python以其易读性强、语法简洁...

    个人的

    由于标签是"Python",我们可以推测这个项目主要使用Python编程语言,可能是学习笔记、实验项目或者是解决特定问题的代码库。 在这个个人资料库中,我们可能发现以下关于Python的知识点: 1. **基础语法**:Python...

Global site tag (gtag.js) - Google Analytics