第55讲:Python为函数定义文档字符串

news/2024/7/7 20:21:41

文章目录

    • 1.文档字符串的概念
    • 2.文档字符串的定义

1.文档字符串的概念

对于函数、模块、类和方法,都会去定义一个文档字符串,所谓的文档字符串,就是定义一个帮助信息、解释说明,告诉使用者这个函数是做什么用的,文档字符串一般会位于函数体中的第一行,通常会用三个引号引起来。

之所以称为文档字符串,是因为可以使用工具根据在代码中定义的文档字符串,从而将某个函数的文档字符串打印出来。

作为合格的开发者,应该养成编写文档字符串的习惯,以提高程序的可读性。

函数中文档字符串的定义规则:

  • 在文档字符串的第一行,简洁主题,看到这个文档字符串就明白函数的作用和功能。
  • 文档字符串中第一行的首字母一般都要大写,第一行以句号结尾。
  • 如果文档字符串中包含多行,第二行一般都是空行,从第三行开始详细进行描述。

2.文档字符串的定义

查看某个函数的文档字符串,通过__doc__这个属性来查询。

print(sorted.__doc__

http://lihuaxi.xjx100.cn/news/1197553.html

相关文章

ChatGPT:生成式AI的十年繁荣与2033年1.5万亿美元市场规模展望

ChatGPT:生成式AI的十年繁荣与2033年1.5万亿美元市场规模展望 在过去的十年里,我们见证了生成式AI的繁荣。从最初的GPT系列模型到现今的ChatGPT,该领域取得了令人瞩目的进步。在本文中,我们将深入探讨生成式AI的发展历程、它对各…

Three.js入门教程:使用代码实现引入模型的例子

Three.js是一款基于WebGL的JavaScript 3D图形库,它可以让开发者在浏览器中创建和展示3D图形,包括模型、动画、场景等。本文将介绍如何使用Three.js入门,并通过一个实例来演示如何引入一个模型。 一、环境搭建 在使用Three.js之前&#xff0…

Windows10系统下使用IDEA创建SpringBoot项目(二)

步骤 打开IntelliJ IDEA,选择 Create New Project选择 Spring Initializr在弹出的窗口中,选择项目名称、项目路径、项目类型、语言和Spring Boot版本等点击 Next填写 Group、Artifact、Name、Description、Package等信息点击 Next选择 Spring Boot Star…

Hive和Hadoop关系

Hive是基于Hadoop的一个数据仓库工具,用来进行数据提取、转化、加载,这是一种可以查询和分析存储在Hadoop中的大规模数据的机制。Hive数据仓库工具能将结构化的数据文件映射为一张数据库表,并提供SQL查询功能,能将SQL语句转变成Ma…

Redis安装部署

Redis安装部署【简单】 简介 redis是一个开源的、使用C语言编写的、支持网络交互的、可基于内存也可持久化的Key-Value数据库。 redis的特点就是:快,可以基于内存存储数据并提供超低延迟、超快的检索速度 一般用于在系统中提供快速缓存的能力。 安装…

病毒分析丨一款注入病毒

作者丨黑蛋 一、病毒简介 SHA256: de2a83f256ef821a5e9a806254bf77e4508eb5137c70ee55ec94695029f80e45 MD5: 6e4b0a001c493f0fcf8c5e9020958f38 SHA1: bea213f1c932455aee8ff6fde346b1d1960d57ff 云沙箱检测: 二、环境准备 系统 Win7x86Sp1 三、行为监控 打开…

完成MQTT客户端,前几年的欠债还上了

最近有点儿忙,努力方向很重要,最近VFP硬件开发课已完结,顺便补一下前面欠的MQTT完整客户端,支持QOS0,OQS1,LAST WILLMSG. QOS2的支持看有需求再说了。 猫猫的心里话 加菲猫的VFP|狐友会社群接收投稿啦 加菲猫的VFP,用…

【Java多线程进阶】线程池详解

前言 在大量的并发任务中,频繁的创建和销毁线程对系统的开销是非常大的,多个任务执行的速度也是非常慢的。因此,设计出一个好的 Java 线程池就可以减少系统的开销、使程序运行速度提升。在这篇博文中,我将介绍 Java 线程池概念以及…