Python学习笔记010——函数文档字符串

函数文档字符串documentation string (docstring)是在函数开头,用来解释其接口的字符串。简而言之:帮助文档

  1. 包含函数的基础信息
  2. 包含函数的功能简介
  3. 包含每个形参的类型,使用等信息
  4. 是接口设计的重要部分。
  5. 注:一个良好的接口不能简单、清晰的表述该函数,则说明该函数还有优化改进的空间

函数文档的使用

  1. 必须在函数的首行,经过验证前面有注释性说明是可以的,不过最好函数文档出现在首行
  2. 使用三引号注解的多行字符串(当然,也可以是一行),因三引号可以实现多行注解(展示)(‘‘‘ ‘‘‘) 或(""" """)
  3. 函数文档的第一行一般概述函数的主要功能,第二行空,第三行详细描述。

查看方式

  1. 在交互模式下可以使用help查看函数,帮助文档,该界面会跳到帮助界面,需要输入q退出界面
  2. 使用__doc__属性查看,该方法的帮助文档文字直接显示在交互界面上。

举例说明

def test():
    ‘‘‘
        函数名:test
        功能:测试
        参数:无
        返回值:无
    ‘‘‘
    print("函数输出成功")

test()

在交互模式下输入

 >>> import day10
 >>> help(day10.test)

最后在帮助界面显示如下

按q键退出

同样在交互模式下出入

>>> import day10
>>> print(day10.test.__doc__)

        函数名:test
        功能:测试
        参数:无
        返回值:无

>>> 

截图如下

在其下直接显示帮助文档。

时间: 2024-11-03 01:22:53

Python学习笔记010——函数文档字符串的相关文章

python学习笔记之函数总结--高阶函数以及装饰器

python学习笔记之函数总结--高阶函数以及装饰器 Python特点: 1.不是纯函数式编程(允许变量存在): 2.支持高阶函数(可以传入函数作为变量): 3.支持闭包(可以返回函数): 4.有限度的支持匿名函数: 高阶函数: 1.变量可以指向函数: 2.函数的参数可以接收变量: 3.一个函数可以接收另一个函数作为参数: 下面我将示例一些函数的写法以及使用,并说明python中函数的特性: 1.基本的高阶函数示例: #!/usr/bin/env python def func():      

HTML&CSS基础学习笔记4-定义文档类型

定义HTML的文档类型 Web 世界中存在许多不同的文档.只有了解文档的类型,浏览器才能正确地显示文档. HTML 也有多个不同的版本,只有完全明白页面中使用的确切 HTML 版本,浏览器才能完全正确地显示出 HTML 页面.这就是 <!DOCTYPE> 的用处. <!DOCTYPE> 声明不是 HTML 标签,它是指示 web 浏览器关于页面使用哪个 HTML 版本进行编写的指令.是一种标准通用标记语言的文档类型声明,它的目的是要告诉标准通用置标语言解析器,它应该使用什么样的文档

Sharepoint学习笔记—ECM系列—文档列表的Metedata Navigation与Key Filter功能的实现

如果一个文档列表中存放了成百上千的文档,想要快速的找到你想要的还真不是件容易的事,Sharepoint提供了Metedata Navigation与Key Filter功能可以帮助我们快速的过滤和定位我们想要查找的文档. 效果如下: 下面我们来看看如何设置实现这个功能. 1.打开你想要操作的文档库,点击此库的Library选项页及其Library Settings按钮 点击此Ribbon上的Library Setting按钮 2.在文档库的管理页面的Gegeral Settings栏,找到Met

Python学习笔记010——匿名函数lambda

1 语法 my_lambda = lambda arg1, arg2 : arg1 + arg2 + 1 arg1.arg2:参数 arg1 + arg2 + 1 :表达式 2 描述 匿名函数不需要return来返回值,表达式本身结果就是返回值. lambda 仅简洁了代码,并不会提高程序运行效率 如果可以用 for...in...if 来完成的,最好不使用匿名函数lambda 使用lambda时,函数内不要包含循环.嵌套:如果存在,则最好使用def函数来完成,这样的代码可读性和复用性均较高 l

Python学习笔记003_函数

>>> # 函数>>> def myFirstFunction(params1,params2...): print("这是我的第一个函数!") print("Python你好吗?") >>> #调用函数>>> >>> myFirstFunction()这是我的第一个函数!Python你好吗? >>>  # 函数的返回值  return #函数文档, 就是函数

python学习笔记(函数)

懒惰即美德 斐波那契数列 >>> fibs=[0,1]>>> for i in range(8): fibs.append(fibs[-2]+fibs[-1]) >>> fibs[0, 1, 1, 2, 3, 5, 8, 13, 21, 34] or fibs=[0,1]num=input('How many fibonacci numbers do you want?')for i in range(num-2): fibs.append(fibs[

EXCEL基础内容学习笔记(二)Excel文档的基本组成与功能介绍

一.基本组成 (一)工作簿.工作表与单元格 (1)工作簿:一个Excel文档即为一个工作簿. (2)工作表:工作簿中的每个表. (3)单元格:打开Excel文档,在工作表中单击,出现的加粗四边形即为单元格.单元格由行和列组成,命名时由行和列说明,称为单元格名称或地址. 一个工作簿中有若干个工作表,每个工作表有许多单元格组成. 二.功能介绍 (1)标题栏:Excel文档最上端. (2)选项卡 (3)工作区:每一个打开的选项卡都含有若干工作区. (4)名称框:所选择的单元格的名字. (5)编辑栏:可

学习笔记:javascript 文档对象(document)

1.documnet函数 方法 描述 close() 关闭用 document.open() 方法打开的输出流,并显示选定的数据. getElementById() 返回对拥有指定 id 的第一个对象的引用. getElementsByName() 返回带有指定名称的对象集合. getElementsByTagName() 返回带有指定标签名的对象集合. open() 打开一个流,以收集来自任何 document.write() 或 document.writeln() 方法的输出. write

Python学习笔记五_数据类型(字符串)

已经学习过的数据类型包括:int.float.list.tuple.dict.这篇来单独记录下字符串.单独将字符串这种数据类型写出来,是因为python里有很多非常有用的字符串内置方法. 一.字符串定义 字符串可以存任意类型的字符串,比如名字,一句话等等. 1 name = 'Rebecca' 2 msg = 'Fighting' 二.字符串内置方法 1.常用方法 输出为字符串的方法 a = 'my name is Rebecca' print(a.capitalize()) #将字符串的第一个