- 综合排序
- 最热优先
- 最新优先
- 来自专栏后端知识体系
Python中的Docstring
# 基本教程 ''' 文档字符串的应用 该文档字符串所约定的是一串多行字符串，其中第一行以某一大写字母开始，以句号结束。 第二行为空行，后跟的第三行开始是任何详细的解释说明。 在此强烈建议你在有关你所有非 凡功能的文档字符串中都遵循这一约定。 ''' def print_max(x, y): '''Prints the maximum of two numbers.打印两个数值中的最大数。 The two values must be integers.这两个数都应该是整数
49140编辑于 2022-07-14 - 来自专栏从零开始学自动化测试
python笔记30-docstring注释添加变量
docstring也就是给代码加注释的内容了，python可以给函数，类、方法，模块添加注释内容，注释标准格式一般是三个双引号（或三个单引号） docstring 先看一个简单案例，在函数里面添加注释内容 __doc__ # 获取类的docstring内容 print(b) c = Hello.world. __doc__ # 获取方法的docstring内容 print(c) 运行结果 这个是该模块的注释内容：hello.py hello类，实现xx功能 world方法，打印world 如果函数里面带有参数 添加变量 在docstring里面添加变量内容，变量的部分用%s代替，最后取值的时候，前面加一行代码 用变量替换里面的%s部分 coding:utf-8 c = “这里是变量内容” def hello a = hello.doc print(a) 案例2-添加2个参数 @docstring_parameter(“打印hello”, “打印world”) def world(): “”” 实现功能
1.9K20发布于 2018-10-24 【python 关于python的文档字符串(docstring)】的注意点
Python 中的函数只能有一个文档字符串（docstring），它必须是紧跟在函数定义后面的第一段字符串，位于函数体代码之前。
11910编辑于 2026-01-23- 来自专栏云云众生s
使用文档字符串记录Python代码
Docstring 当你知道你的注释将占用多行，并且不想用一列 # 字符来使代码混乱时，docstring 是一种很好的注释方法。 要正确完成 docstring，在结束的 “”” 和下一行代码之间应该有一个空格。 类 Docstring 然后是类 docstring，用于解释你创建的类。 return 2 * 3.14159 * self.radius 如你所见，我们有一个多行类 docstring 和两个单行 docstring。 你可以使用其他 docstring，例如： 包和模块 docstring：列出导出的模块和子包。这些类似于类 docstring，只是用于模块及其内部的函数。 脚本 docstring：描述整个 Python 脚本或模块的总体目的和功能的 docstring。 这就是你对 Python docstring 的介绍。
32110编辑于 2024-10-22 - 来自专栏python3
Python模块——doctest
doctest在docstring的部分加入测试代码，以一种简单的方式进行测试。 2.期望的测试结果与docstring之间要有一个空行。 """ >>> add(1, 2) 3 a docstring #这个会被认为是测试输出的一部分 """ 应该写成这样 """ >>> add(1, 2) 3 a docstring """ 作用 官方文档提到的应用情景： 1.通过验证例子（doctest）检查模块的docstring是最新的。 有时候会出现代码已经改变但docstring没有更新的情况，在docstring中加入doctest可以尽量避免这种情况的发生。
54210发布于 2020-01-07 - 来自专栏从零开始学自动化测试
python笔记36-装饰器之wraps
name和doc __name__用于获取函数的名称，__doc__用于获取函数的docstring内容（函数的注释） import timedef func_a(a): '''func_a --> hello __doc__) # func_b --> world 装饰器加函数名称日志 在装饰器里面添加2行代码，打印正在运行函数的名称和docstring内容 import timedef runtime( __name__) print("docstring: %s" % func. __name__) print("docstring: %s" % func. __name__) print("docstring: %s" % func.
55130发布于 2019-05-14 - 来自专栏python3
Python 代码规范
文档字符串 (docstring) 使用三个双引号"""......""" 2.4、空行 模块级函数和类定义之间空两行； 类成员函数之间空一行； class A: def __init__(self docstring 的规范中最其本的两点： 所有的公共模块、函数、类、方法，都应该写 docstring 。 docstring 的结束"""应该独占一行，除非此 docstring 只有一行。 ） 作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的doc对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.
1.9K10发布于 2020-01-07 - 来自专栏python3
启用 VIM 中的 Python 自动补
此时， 按下 Ctrl+x, Ctrl+o， 就能看到提示列表框，以及对应的 docstring. Ctrl+n, Ctrl+p 来上下选择 ESC 来取消提示框。 a. 属性没有 docstring， 只有函数有。 :( 这个似乎不好搞，因为属性似乎没有 docstring 这个概念。 b. 在没有下拉框的情况下，没有 docstring.
1.2K30发布于 2020-01-09 - 来自专栏编程黑洞
ddt源码分析
= _get_test_data_docstring(func, v) if hasattr(func, UNPACK_ATTR): def add_test(cls, test_name, test_docstring, func, *args, **kwargs): setattr(cls, test_name, feed_data (func, test_name, test_docstring, *args, **kwargs)) def feed_data(func, new_name, test_data_docstring __wrapped__ = func # set docstring if exists if test_data_docstring is not None: __doc__ = test_data_docstring else: # Try to call format on the docstring if
55310编辑于 2023-03-06 - 来自专栏吾非同
你需要知道的Python代码规范性检查（pylint和flake8）
+ 目标项目或者文件 pylint pychek.py 输出： ************* Module pycheck pycheck.py:1:0: C0114: Missing module docstring (missing-module-docstring) pycheck.py:1:0: C0116: Missing function or method docstring (missing-function-docstring conform to snake_case naming style (invalid-name) pycheck.py:3:0: C0116: Missing function or method docstring (missing-function-docstring) ------------------------------------------------------------------ Your 从检查信息可以看到，上述代码缺少模块注释（Missing module docstring）以及函数注释（Missing function docstring），函数名不符合蛇形命名规范（全由小写字母和下划线组成
8.9K30发布于 2020-10-23 - 来自专栏决策智能与机器学习
算法集锦（13）|自然语言处理| Python代码的语义搜索引擎创建
收集这些数据之后，我们需要将这些文件解析为code-docstring(代码、文档字符串)对。对于本教程，一个代码单元将是顶级函数或方法。 我们将匹配后的code-docstring对作为模型的训练数据，以便对代码进行处理(稍后将详细介绍)。我们还去掉了所有注释，只保留代码。 (function/method, docstring) pairs from a given code blob.""" = ast.get_docstring(f) if ast.get_docstring(f) else '' function = source.replace(ast.get_docstring 下图展示了一些示例，我们在向量化的docstring中搜索用户提供的短语的相似性。 ?
1.8K10发布于 2020-08-04 - 来自专栏python3
Python代码规范和命名规范
文档字符串 (docstring) 使用三个双引号 """......""" 2.4、空行 模块级函数和类定义之间空两行； 类成员函数之间空一行； class A: def __init__( docstring 的规范中最其本的两点： 所有的公共模块、函数、类、方法，都应该写 docstring 。 docstring 的结束"""应该独占一行，除非此 docstring 只有一行。 作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.
2.6K20发布于 2020-01-10 - 来自专栏python学习教程
Python代码规范之简明概述
文档字符串 (docstring) 使用三个双引号 """......""" 2.4、空行 模块级函数和类定义之间空两行； 类成员函数之间空一行； class A: def __init__( 一定要换行： # 正确的写法 if foo == 'blah': do_blah_thing() # 不推荐的写法 if foo == 'blah': do_blash_thing() 6、docstring docstring 的规范中最其本的两点： 所有的公共模块、函数、类、方法，都应该写 docstring 。 docstring 的结束"""应该独占一行，除非此 docstring 只有一行。 """Return a foobar Optional plotz says to frobnicate the bizbaz first. """ """Oneline docstring"""
83421发布于 2019-08-23 - 来自专栏非典型性程序员
Python 新手突破瓶颈指南：functools.wraps 元数据复制
def my_decorator_without_wraps(func): def wrapper(*args, **kwargs): """Wrapper function docstring __doc__) # 输出: Wrapper function docstring. __doc__) # 输出: Example function docstring. __doc__ 输出被装饰函数的文档字符串，这里输出 Wrapper function docstring.，而不是 Example function docstring.。 __doc__ 输出被装饰函数的文档字符串，这里输出 Example function docstring.，而不是 Wrapper function docstring.。
76210编辑于 2024-08-09 - 来自专栏CVer
这个开源深度学习框架项目参与指北来了！内含易上手任务清单
任务解读 目前，MegEngine 的 Python 文档字符串从内容完整度、情景覆盖描述、质量等方面还有极大的优化空间，希望能够得到社区同学的帮助，完善 MegEngine API Docstring 在参与过程中，请注意： 提交的 API Docstring 建议至少包括以下内容（英文）： 该 API 功能简介 输入参数说明 返回值类型及说明 规范符合 《数组 API 标准》 Pull Request 2、找到想要做的任务 在 MegEngine Python API Docstring Enhancement项目中，找到一个自己希望帮助 MegEngine 团队改进文档字符串的 API。 4、基于 master 分支创建一个新的分支（例如 docstring-arange ），在此新分支上修改 API 文档字符串内容： $ git checkout -b docstring-arange " $ git push origin docstring-arange 5、此时在 GitHub 打开你 Fork 的仓库地址，会有相关的提示： 点击 "Compare & pull request
69810编辑于 2021-12-13 - 来自专栏TalkPython
Python注释与doctoring
单行注释、多行注释 单行注释 # 这是python的单行注释 多行注释 这是多行注释 这是多行注释 以编程方式访问文档字符串 与常规注释不同，docstring是作为它们所记录的函数的属性存储的，这意味着您可以通过编写程程序访问它们 __doc__) 运行程序后，输出： 这是一个函数的注释说明 docstring相对于常规注释的优点 在函数中不添加docstring或常规注释就会大大降低它的帮助。 运行上面的代码，就会输出： None help(greet) Help on function greet in module main: greet(name,greeting='Hello') 使用docstring 编写注释文档 docstring是一个多行注释，用于记录模块、类、函数和方法。
1.5K20发布于 2019-06-11 - 来自专栏python3
刚毕业去面试Python工程师，这几道题
写在前面 本想停一段时间这个系列，但是好多朋友给我发信息说让我继续整理下去，so，继续吧~ 第1题： docstring是什么？ docstring是一种文档字符串，用于解释构造的作用。 我们用三个单引号或双引号来声明docstring。 >>> def say(): """ 这是docstring """ print("docstring") >>> say() docstring >>> 要想获取一个函数的 docstring，我们使用它的_doc_属性 第2题：PYTHONPATH变量是什么？
70810发布于 2020-01-16 - 来自专栏python前行者
[1263]python代码分析工具pylint
(missing-module-docstring) # 脚本首行没有添加注释 leetcode/704.py:4:11: W0621: Redefining name 'nums' from outer (missing-function-docstring) #函数缺少注释，注释要放在函数的第一行而不是def的上面 注意事项 在使用pylint检查Python代码时，需要注意以下事项： pylint 从检查信息可以看到，上述代码缺少模块注释（Missing module docstring）以及函数注释（Missing function docstring），函数名不符合蛇形命名规范（全由小写字母和下划线组成 module docstring (missing-module-docstring) pylint_demo/s2.py:7:0: C0116: Missing function or method docstring (missing-function-docstring) Report ====== 8 statements analysed.
2K10编辑于 2024-01-21 - 来自专栏DevOps时代的专栏
如何写好 DevOps 的文档
使用fab -d [task_name]可以显示该任务完整的docstring。规整的docstring可以让执行任务的用户清楚地理解其作用及参数用法。 我们在写fabric任务的docstring时，一般分为三个部分 任务的简单介绍 任务的参数 具体用例 最后一点由为重要，有些任务参数众多，即使读了参数说明，仍会让人有些云里雾里。 在Python中，docstring其实就是函数的__doc__的属性，所以我们可以像修改普通变量那样动态修改docstring，这给我们生成动态文档或是重用公共的文档提供了可能。 这里我们用Python的decorator来动态地把可用服务的信息添加到docstring中。 动态外部文档 除了docstring，我们也经常需要写独立的外部文档。在Glow，这些文档绝大部分都是用Markdown来写的。
79030发布于 2018-08-01 - 来自专栏Python七号
如何让 Python 代码更专业？
some_python_scripts.py ************* Module some_python_scripts some_python_scripts.py:1:0: C0114: Missing module docstring (missing-module-docstring) some_python_scripts.py:5:16: C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name) some_python_scripts.py:5:0: C0116: Missing function or method docstring (missing-function-docstring) some_python_scripts.py:21:0: C0116: Missing function or method docstring (missing-function-docstring) some_python_scripts.py:21:18: W0621: Redefining name 'numbers' from outer
1.2K20编辑于 2022-05-24
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号