Python 基础 —— docstring

最新推荐文章于 2024-05-01 01:13:43 发布
最新推荐文章于 2024-05-01 01:13:43 发布
阅读量1.6k 收藏
点赞数
分类专栏： python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lanchunhui/article/details/51588976
版权

docstring 是指：

  • 短字符串

    • 单引号：''
    • 双引号：" "

  • 跨行字符串

    • 三单引号：''' '''
    • 三双引号：""" """

比如如下的 Point.py 文件：

class Point:
	' ... '
	
	def __init__(self, x=0, y=0):
		''' ...
		    ...
		'''

那么该如何查阅 docstring：

$ python -i point.py
>> import point
>> help(Point)
...

1. doc 级别

  • 包级别的 doc：__init__.py文件，文件头部的""" """三个双引号之间；

    >> import requests
>> requests.__file__	
			# __init__.py 文件的路径
>> help(requests)

  • 类级别的 doc：class 声明之后，__init__构造函数之前；

  • 函数级别；

五道口纳什
关注
专栏目录
36. Python方法——《跟老吕学Python·新手》
Python老吕的博客
05-02 76
在Python中，方法（Method）是与对象相关联的函数，它们可以访问和修改对象的状态。方法通常定义在类中，并且是对象行为的一部分。 ### 36.1 实例方法 实例方法是与类的实例（对象）相关联的方法，它们定义了对象的行为。以下是对实例方法的进一步阐述： - **定义**: 实例方法在类中定义，并且需要一个额外的参数 `self` 作为第一个参数。`self` 参数在调用方法时自动传入，它代表了当前的实例对象。 - **调用**: 实例方法可以通过实例对象调用，例如 `obj.method()`
32. Python模块——《跟老吕学Python·新手》
最新发布
Python老吕的博客
05-01 29
模块是Python中一种基本的代码组织单元，它允许我们将代码划分为可重用的、功能明确的部分。模块可以包含函数、类、变量等，并且可以被其他Python代码导入和使用。模块在Python中是一个.py文件，这个文件包含了Python代码。函数（Functions）类（Classes）变量（Variables）常量（Constants）导入语句（Import statements）导入自定义模块的方式与导入标准库模块相同。只需确保自定义模块的文件位于Python的搜索路径中。
100天精通Python丨黑科技篇 —— 21、大语言模型_100天精通python快速入门到黑科技
m0_60452141的博客
04-26 591
ChatGPT 是 OpenAI 推出的一种基于 GPT-3/4 的聊天机器人。chatgpt 的颠覆性影响主要体现在提高语言交流的便捷性、个性化服务、自动化客服和教育娱乐等方面，这些应用可以为用户带来更多的便利和乐趣，同时也为企业提供了更多的服务和商机。本文收录于，是由的硬核博主倾力打造，分基础知识篇和黑科技应用两大部分，欢迎订阅本专栏，订阅后可私聊进Python全栈VIP交流群（问题解答、互相帮助）还可领取20GPython视频和100本互联网行业电子书。
Python常用函数--文档字符串DocStrings
weixin_34124577的博客
04-08 268
Python 有一个甚是优美的功能称作Python文档字符串（Documentation Strings），在称呼它时通常会使用另一个短一些的名字docstrings。DocStrings是一款你应当使用的重要工具，它能够帮助你更好地记录程序并让其更加易于理解。令人惊叹的是，当程序实际运行时，我们甚至可以通过一个函数来获取文档！案例（保存为 functi...
python docstring
我是张先生
12-10 306
def hello(): """ output 'hello' :return: """ print('hello') print(hello.__doc__) 参考
Docstring
dangfulin的博客
10-24 4986
一，什么是docstring docstring是一个字符串文字，它作为模块，函数，类或方法定义中的第一条语句出现。这样的文档字符串会成为该对象的__doc__属性。 ——PEP 257 – Docstring Conventions 通常，所有模块都应具有文档字符串，并且模块导出的所有函数和类也应具有文档字符串。 公共方法（包括__init__构造函数）也应具有文档字符串。 软件包可以记录在软件包目录的_init_.py文件的文档字符串中。 Python代码中其他地方出现的字符串文字也可以用作文档。
零基础入门python3.7 ——基础知识总结(十) 函数基础
12-21
本篇主要介绍了Python函数的基础知识，包括函数的定义、调用、参数、返回值以及相关注意事项。 1. **函数的基本概念** 函数是Python中实现特定功能的代码段，比如`input()`用于获取用户输入，`print()`用于输出...
python项目 —— rocket-flight-simulator
02-18
"Python项目——rocket-flight-simulator"是一个利用Python编程语言实现的简单火箭飞行模拟器。这个项目专注于后端开发，通过代码模拟火箭的飞行过程，包括发射、升空、轨迹计算等关键环节。以下是对该项目涉及的...
31. Python函数——《跟老吕学Python·新手》
Python老吕的博客
05-01 31
函数定义是创建函数的第一步，它告诉Python解释器函数的名称、参数和功能。Python使用def关键字来定义函数。封装性：函数将一段代码封装起来，形成独立的功能模块。可重用性：定义好的函数可以在不同的地方重复调用。抽象性：函数提供了一种抽象层，隐藏了实现的细节。代码复用：避免代码重复，提高开发效率。逻辑分离：将程序分解为逻辑单元，使代码结构更清晰。参数化操作：通过参数传递，实现对不同数据的操作。文档字符串：使用三个引号"""定义函数的文档字符串，为函数提供帮助信息。类型注解。
Python中的DocStrings
qq_19277921的博客
10-16 1958
DocStrings（文档字符串）是Python中的一个特性，它可被用于函数、模块和类。 它的作用是为程序添加注释，让程序更加的简单易懂（即增加程序可读性）。 例如可以在函数后书写DocStrings，用于解释函数的作用、参数的类型与意义、返回值类型与取值范围等。def printMax(x,y): '''Print the maximum of two numbers. The two
python的DocStrings
CSDN_YJX的博客
10-20 440
DocStrings简介：案例它是如何工作的 简介： Python 有一个甚是优美的功能称作文档字符串（Documentation Strings），在称呼它时通常会使用另一个短一些的名字docstrings。 DocStrings 是一款你应当使用的重要工具，它能够帮助你更好地记录程序并让其更加易于理解。令人惊叹的是，当程序实际运行时，我们甚至可以通过一个函数来获取文档！ 案例 def print_max(x, y): '''Prints the maximum of two numbers.打印
python 的 DocStrings
fanzirong_的博客
07-29 572
1、首先DocString可以说相当于函数里的一个注释。 2、写法 def hello(): ''' This is hello function. It will be print hello world.''' print 'hello world' hello() print hello.__doc__ DocStrings 就是函数里三引号中的部分，用于注释函数...
Python的docstring规范（说明文档的规范写法）
热门推荐
Castlehe的博客
11-22 2万+
其实，标准规范里，python代码写完都要进行规范性测试。 比如： black . # 帮你添加空格，看起来好看 flake8 # 检查不规范的地方 然后会检查出代码不规范的地方，进而修改，比如下面这样的 ✨ 1. python dostring规范 ...
docstring
A Flying Bird
06-23 880
docstring的语法简介
python面试题之docstring是什么？
08-28 1115
Docstring是一种文档字符串，用于解释构造的作用。我们在函数、类或方法中将它放在首位来描述其作用。我们用三个单引号或双引号来声明docstring。 >>> def sayhi(): """ 用该函数打印Hi """ print("Hi") >>> sayhi() Hi 要想获取一个函数的docstring，我们使...
Python DocString特性
gukesdo的专栏
11-27 3991
#!/usr/bin/python #Filename:func_doc.py def printMax(x,y): '''Prints the maximum of two numbers the two valuse must be integers''' x = int(x) y = int(y) if(x > y): print x,'is maximum' els
DocString
weixin_30321449的博客
01-27 161
文档字符串：写注释专用的， 在函数的第一个逻辑行的字符串是这个函数的文档字符串。注意，DocStrings也适用于模块和类，我们会在后面相应的章节学习它们。 文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。强烈建议你在你的函数中使用文档字符串时遵循这个惯例。 转载于:https://www.cnblogs.com/sak...
Python中docstring的写法
Serene Nest
09-26 560
python中class或者methon的__doc__有多行时有'''\作为首行比较直观 '''\ Programming is fun When the work is done if you wanna make your work also fun: use Python! ''' 这种方法也可以用于定义多行String temp = '''\ Pro...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

五道口纳什

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值