python函数文档注释的简单介绍

Python 语句和注释

我们将在本节中介绍 Python 语句，缩进以及注释，在本节的最后一部分，还会介绍作为一种特殊类型的 Python 注释 Docstring 。

Python 语句是给解释器执行的指令，一条 Python 语句包含类似于如下的表达式，

你可以将 Python 语句堪称解释器解释表达式并将其结果存储在变量中的指令。类似于 for , while , print 之类的语句具有特殊的含义，我们将在在后面的章节中讨论。

当你在一句语句结束时按回车键后，该 Python 语句被终止，我们可称之为单行语句。Python 中的多行语句可以通过使用连续字符 来创建，它将 Python 语句扩展为多行语句。

比如下面的例子，

这可以被称作明确的多行接续。

你还可以使用括号 () ，方括号 [] 或大括号 {} 来进行隐式的多行接续。

例如，你可以使用括号来连接多行语句，

Python 语句块，例如函数，循环或类的主体，以缩进来开头。对于语句块内的每个语句，应该保持相同的缩进。当缩进不一致时，你将得到什么什么 IndentationError 。

一般来说，在

Python 代码样式指南

中建议使用 4 个缩进空格。举例如下，

我们用缩进来增加程序的可读性，比如在下面的程序中，我们用两种方式来完成同一个功能，

你可以在这里看到第一个例子比第二个例子有更好的可读性。

注释用于描述程序的目的或工作工程，注释是在 Python 解释过程中被忽略的行为，它们不会干扰程序的流程。

如果你正在编写数百行代码，肯定需要添加注释，因为其他人在阅读你的代码的时候，没有足够的时间阅读每一行来理解代码的工作。程序的注释增加了可读性，并解释了代码的工作原理。

Python 注释以井号 # 开始

Using hash symbol in each line can define a multi-line comment. But there is another way to add a multi-line comment in Python, that is using triple quotation marks. You can use either ''' or """ .

三重引号 ''' 通常可以用来定义多行文档注释 Docstring ，你也可以用它来作为另外一种在 Python 中添加多行注释的方法。

Docstring 是文档字符串，它通常是 Python 函数，类，模块等的第一条语句。函数，方法和类的描述和注释位于文档字符串（文档字符串）内。

举例如下，

一目了然， Docstring 介绍了函数的功能。

相关问答

Q1: 乌班图gedit文本编辑器怎么快速注释python代码

1、首先在Python2022中可以对代码进行单行注释。

2、其次找到即可框选想要注释的内容。

3、最后按下快捷键Ctrl+就可以快速注释了。

Q2: python如何批量注释

如果是多行注释，可在每行注释前面加“#”号；也可用3个双引号括起来；还可以用3个单引号括起来。另一种方法，选中要注释的代码，然后按“Ctrl+/”键即可批量注释。

Q3: Python函数注解使用有哪些注意事项呢？

函数注解是关于用户自定义的函数的完全可选的、随意的元数据信息。

1.无论 Python 本身或者标准库中都没有使用函数注解；本节只是描述了语法。第三方的项目是自由地为文档，类型检查，以及其它用途选择函数注解。

2.注解是以字典形式存储在函数的 __annotations__ 属性中，对函数的其它部分没有任何影响。参数注解（Parameter annotations）是定义在参数名称的冒号后面，紧随着一个用来表示注解的值得表达式。返回注释（Return annotations）是定义在一个 - 后面，紧随着一个表达式，在冒号与 - 之间。下面的示例包含一个位置参数，一个关键字参数，和没有意义的返回值注释:

def f(ham: 42, eggs: int = 'spam') - "Nothing to see here":

... print("Annotations:", f.__annotations__)

... print("Arguments:", ham, eggs)

...

f('wonderful')

Annotations: {'eggs':

, 'return': 'Nothing to see here', 'ham': 42}

Arguments: wonderful spam

Q4: Python-openpyxl教程11 - 注释和样式

注释具有text属性和author属性，必须同时设置它们。

加载时工作薄中存在的注释会自动存储在其相应单元格的注释属性中。格式信息(如字体大小，粗体和斜体)以及注释的容器框的原始尺寸和位置都将丢失。

保存工作薄时保留在工作薄中的注释会自动保存到工作薄文件中

注释尺寸可以指定为只写。评论尺寸以像素为单位。

如果需要, openpyxl.utils.units 包含用于从其他度量单位(例如mm或点)转换为像素的辅助函数:

样式用于屏幕上显示时更改数据的外观。他们还用于确定数字的格式。

样式可以应用于以下方面：

- 用于设置字体大小，颜色，下划线等的字体

- 填充以设置图案或颜色渐变

- border可以设置单元格的边框

- 单元格对齐

- 保护

以下是默认值：

有两种类型的样式：单元样式和命名样式，也成为样式模板

单元格样式在对象之间共享，并且一旦分配了它们就无法更改。这样可以避免不必要的副作用，例如，仅更改一个单元格时就可以更改许多单元格的样式。

样式也可以复制

字体，背景，边框等的颜色都可以通过三种方式设置：索引，aRGB或主题。 索引颜色是旧版实现，颜色本身取决于工作薄或应用程序默认提供的索引。主题颜色可用于互补色，但也取决于工作薄中存在的主题，因此，建议使用RGB颜色。

RGB颜色使用红色，绿色和蓝色的十六进制值设置

理论上，alpha值是指颜色的透明度，但这与单元格样式无关。默认值00将加在任何简单的RGB值之前:

还支持传统索引颜色以及主题和色彩。

索引64和65不能设置，并且分别留给系统前景色和背景色

样式直接应用于单元格

样式也可以应用于行和列，但是请注意，这仅适用于关闭文件后再Excel中创建的单元格。如果要将样式应用于整个行和列，则必须自己将样式应用于每个单元格。这是文件格式的限制：

合并的单元格的行为与其他单元格对象相似。其值和格式在其左上角的单元格中定义。为了更改整个合并单元格的边框。请更改其左上角单元格的边框。格式化是出于编写目的而生成的。

与单元格样式相反，命名样式是可变的。当您想一次将格式应用于许多不同的单元格时，它们很有意义。注意: 将命名样式分配给单元格之后，对样式的其他更改将不会影响该单元格。

一旦将命名样式注册到工作薄中，就可以简单的通过名称来引用它。

创建命名样式后，可以将其注册到工作薄中：

wb.add_name_style(highlight)

但是，命名样式在首次分配给单元时也将自动注册：

ws['A1'].style = highlight

注册后，仅使用名称分配样式：

ws['D5'].style = 'highlight'

该规范包括一些内置样式，也可以使用，不幸的是，这些样式的名称以本地化形式存储。

openpyxl仅会识别英文名称，并且只能与此处的文字完全一样。如下：

Number formats

Informative

Text Styles

Comparisons

Highlights