锐客网

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

python函数内注释的简单介绍

IT技术注释

Python函数注解使用有哪些注意事项呢？函数注解是关于用户自定义python函数内注释的函数的完全可选的、随意的元数据信息 。
1.无论 Python 本身或者标准库中都没有使用函数注解python函数内注释；本节只是描述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
python的注释python中的注释一般分为单行注释、多行注释以及文档注释 。
1、单行注释：在所需注释行前面加上英文#号或使用crtl /快捷键进行操作 。
2、多行注释：按住鼠标左键，选中所需注释的全部行，按住crtl /快捷键 。
【python函数内注释的简单介绍】3、文档注释（也可以理解为多行注释）：是三对英文的双引号或单引号 。
Python有哪几种注释方式python中python函数内注释的注释有单行注释和多行注释：
1、单行注释(行注释)
python中使用#表示单行注释 。单行注释可以作为单独python函数内注释的一行放在被注释代码行之上python函数内注释，也可以放在语句或表达式之后 。
比如：
# 这是一个注释
print("Hello, World!")
①当单行注释作为单独python函数内注释的一行放在被注释代码行之上时，为python函数内注释了保证代码的可读性，建议在#后面添加一个空格，再添加注释内容 。
②当单行注释放在语句或者表达式之后时，同样为了保证代码的可读性，建议注释和语句之间至少要有两个空格 。
2、多行注释(块注释)
当注释内容过多，导致一行无法显示时，就可以使用多行注释 。多行注释用三个单引号'''或者三个双引号 """将注释括起来 。
①单引号(''')
'''
这是多行注释，用三个单引号
这是多行注释，用三个单引号
这是多行注释，用三个单引号
'''
print("Hello, World!")
②双引号(""")
"""
这是多行注释，用三个双引号
这是多行注释，用三个双引号
这是多行注释 ， 用三个双引号
"""
print("Hello, World!")
3、注意
①注释不是越多越好，对于一目了然的代码 ， 不需要添加注释;
②对于复杂的操作，应该在操作开始前写上相应的注释;
③对于不是一目了然的代码 ， 可以在代码之后添加注释;
④绝对不要描述代码，一般阅读代码的人都了解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介绍了函数的功能 。
关于python函数内注释和的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站 。

    推荐阅读


    上一篇：c语言如何定义输入值的数组元素，c语言自定义函数输入数组

    下一篇：如何在EC服务器上购买宠物？ ec服务器怎么买宠物