`

python -- docstring

阅读更多

def PrintMax(x, y):
    '''Prints the maximum of two numbers.
The two balues must bu integers.''';

    x = int(x);
    y = int(y);

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

PrintMax(1, 3);
print PrintMax.__doc__
 
分享到:
评论

相关推荐

    python-language-server:Python语言服务器协议的实现

    定义,悬停,引用,签名帮助和符号: pip install python-language-server 如果找到相应的依赖项,则将启用以下可选提供程序: 完成和重命名的检测各种错误 Linter用于复杂性检查用于样式检查用于docstring样式检查...

    TOFSense-drive-python-main

    同时,编写详细的注释和使用`docstring`可以提高代码的可读性,方便其他开发者理解和使用。 总之,"TOFSense_drive_python-main"项目展示了如何运用Python与TOFSense传感器进行有效互动,实现数据的实时获取、处理...

    PyPI 官网下载 | docspec_python-0.1.1-py3-none-any.whl

    docspec库的高级特性还包括支持epytext和reStructuredText两种常见的docstring格式,以及对Python的import语句和模块层次结构的处理。此外,它还与Sphinx等文档生成工具很好地集成,可以无缝地将docstrings转换为高...

    Python-VisualStudioCode的Python扩展

    同时,它还支持插件市场中的其他Python相关扩展,如Python Docstring Generator,用于自动生成文档字符串,提升代码可读性。 总的来说,"Python-VisualStudioCode的Python扩展"是Python开发者的得力工具,它通过...

    Python-CoreDocs一个API文档生成器

    **Python-CoreDocs:一个API文档生成器** Python-CoreDocs 是一个强大的工具,专门设计用于自动生成API文档。这个开源项目旨在帮助Python开发者更轻松地管理和分享他们的代码库的文档,节省了手动编写文档的时间和...

    docstring-to-markdown:将Python文档字符串即时转换为Markdown

    docstring到markdown 将Python文档字符串即时转换为Markdown Python 3.6+ 当前可以识别reStructuredText并将其多个功能转换为Markdown 将来也将能够转换Google文档字符串安装pip install docstring-to-markdown例子...

    pbdlib-python-master.zip

    2. **API设计**:库应该遵循PEP 20(Python之禅)和PEP 257(Docstring Conventions)来编写清晰、一致的API。 由于没有具体文件内容,以上分析都是基于一般经验和假设。实际功能和使用方法需要解压并查看库的源...

    python\docutils

    例如,通过解析模块的docstring(文档字符串),可以自动生成API参考文档。这极大地减轻了开发者维护文档的工作负担,确保了文档与代码同步更新。 **6. 扩展和自定义** DocUtils的设计允许用户添加自定义处理器和...

    Python-sublime配置文件

    例如,你可以在此设置文件中指定一组默认要安装的插件列表,如`Anaconda`(提供代码检查和 linting 功能)、`SublimeLinter-flake8`(Python代码风格检查)、`GitGutter`(显示文件的git更改)和`Python Docstring`...

    msgpack-python-0.4.2.tar

    Read the docstring for other options. Streaming unpacking ^^^^^^^^^^^^^^^^^^^ ``Unpacker`` is a "streaming unpacker". It unpacks multiple objects from one stream (or from bytes provided through its...

    Python-Python开发人员指南

    5. **文档编写**:强调了良好的文档对于开源项目的重要性,介绍如何遵循PEP 257(Python Docstring规范)来编写清晰的文档。 6. **性能分析和优化**:讲解如何使用Python的内置工具和第三方库进行性能分析,以及...

    Python-Python最佳实践指南

    - **文档编写**:使用docstring为函数和类添加清晰的文档,以及使用Sphinx生成项目文档。 6. **Python进阶主题**: - **装饰器**:理解装饰器的作用和用法,如何自定义装饰器来增强函数功能。 - **生成器**:...

    nose-docstring-modifier:此插件使您可以在原始文档字符串旁边显示属性

    你可以使用pip安装nose-docstring-modifier插件: $ pip install nose-docstring-modifier 使用 给定以下测试函数: @ attr ( section = 'MySection' , type = 'functional+' , module = 'MyModule' , id = 1 ) ...

    Python-Download南方周末weeklyepaperandcreateEPUBbook

    Python的docstring和unittest模块可以用于此目的。 通过以上这些知识点的结合,我们可以构建出一个完整的解决方案,实现自动下载《南方周末》电子报并生成EPUB电子书的目标。这个项目不仅展示了Python在网络爬虫和...

    Python-Pythonsense是一个Vim插件为Python类方法函数和文档字符串提供文本对象和动作

    插件还特别针对Python的docstring(文档字符串)进行了优化,允许用户轻松地编辑、格式化和导航docstring。这对于保持代码的可读性和维护性至关重要,因为清晰的文档是代码质量的重要组成部分。 3. **Vim编辑器的...

    Python-dictaphone可随时断续的命令行录音工具

    Python的`docstring`和测试框架如`unittest`或`pytest`可能被用来编写这些文档和测试。 通过学习和理解这些知识点,你可以不仅掌握如何使用dictaphone,还可以深入学习Python的音频处理、命令行工具开发以及如何在...

    Python最佳实践指南 Python-Guide-CN-master.zip

    添加文档:为模块和函数写清晰的docstring。 函数化:将重复代码封装成函数,遵循DRY原则。 异常处理:使用try-except处理错误而不是条件检查。 选择合适数据结构:根据需求优化性能。 使用生成器:处理大数据时降低...

    Python-pdoc一个可以替换Epydoc的库可以自动生成Python库的API文档

    `pdoc`支持多种注释风格,包括Python标准的docstring,使得开发者可以根据自己的习惯编写文档。它还能处理类、方法、函数、变量等不同类型的文档,自动识别它们的参数、返回值和异常。此外,`pdoc`还允许你自定义...

    Python-PythonTips一些初学者到中级用户的Python技巧

    学习如何使用docstring编写清晰的函数和模块文档,以及使用sphinx生成项目文档。 14. **错误日志记录**: 使用logging模块记录程序运行过程中的错误和重要事件,以便于问题追踪和调试。 15. **持续集成/持续部署...

    Google代码规约-Python-英文原版-来自GitHub

    2. `pylint`的使用:`pylint`工具可以识别出不同类别的警告,并且每个警告都有一个特定的标识符(例如`empty-docstring`)。谷歌特有的警告以`g-`开头。如果警告的名称不够清楚,需要附上解释说明。为了避免其他问题...

Global site tag (gtag.js) - Google Analytics