锐客网

  1. 首页 > 睿知 > it技术 > >

python函数注释方法的简单介绍

IT技术tft

Python教程：单行多行注释工具/材料
python
01
在python中使用#号表示单行注释
02
使用""" """或''' '''做为多行注释
03
单行注释和多行注释不宜过多,不是每行代表都要注释,最好用来解释函数的操作
04
以下是一些错误使用注释的方式,一些能直接看到结果的代码最好不要多写注释
特别提示
关键代码,复杂代码使用注释
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介绍了函数的功能 。
python 多行注释注释是每一个程序必要的部分，也是一个好程序员的习惯，有以下3种方式：
"""注视内容"""，这一种最强大;
快捷键Alt + 3 ， 需要首先选中要注释的行；
自己写一个函数，然后把内容丢进去 ， 自动添加# 。
Python函数注解使用有哪些注意事项呢？函数注解是关于用户自定义的函数的完全可选的、随意的元数据信息 。
1.无论 Python 本身或者标准库中都没有使用函数注解；本节只是描述了语法 。第三方的项目是自由地为文档，类型检查，以及其它用途选择函数注解 。
2.注解是以字典形式存储在函数的 __annotations__ 属性中 ， 对函数的其它部分没有任何影响 。参数注解（Parameter annotations）是定义在参数名称的冒号后面，紧随着一个用来表示注解的值得表达式 。返回注释（Return annotations）是定义在一个 - 后面 ， 紧随着一个表达式，在冒号与 - 之间 。下面的示例包含一个位置参数，一个关键字参数 ， 和没有意义的返回值注释:

推荐阅读


上一篇：mysql加btree索引，mysql索引 b+树

下一篇：淘宝直播logo素材，淘宝直播间标题大全