锐客网

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

python给函数加注释的简单介绍

IT技术代码

python注释的方式为注释，确保对模块、函数、方法和行内注释使用正确的风格 。
python中的注释有单行注释和多行注释：
1、单行注释(行注释)
python中使用#表示单行注释 。单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或表达式之后 。
比如：
# 这是一个注释
print("Hello, World!")
①当单行注释作为单独的一行放在被注释代码行之上时，为了保证代码的可读性，建议在#后面添加一个空格，再添加注释内容 。
②当单行注释放在语句或者表达式之后时，同样为了保证代码的可读性，建议注释和语句之间至少要有两个空格 。
2、多行注释(块注释)
当注释内容过多 ， 导致一行无法显示时，就可以使用多行注释 。多行注释用三个单引号'''或者三个双引号 """将注释括起来 。
①单引号(''')
'''
这是多行注释，用三个单引号
这是多行注释 ， 用三个单引号
这是多行注释 ， 用三个单引号
'''
print("Hello, World!")
②双引号(""")
"""
这是多行注释，用三个双引号
这是多行注释，用三个双引号
这是多行注释，用三个双引号
"""
print("Hello, World!")
3、注意
①注释不是越多越好，对于一目了然的代码，不需要添加注释;
②对于复杂的操作，应该在操作开始前写上相应的注释;
③对于不是一目了然的代码，可以在代码之后添加注释;
④绝对不要描述代码，一般阅读代码的人都了解python的语法，只是不知道代码要干什么 。
Python教程：单行多行注释工具/材料
python
01
在python中使用#号表示单行注释
02
使用""" """或''' '''做为多行注释
03
单行注释和多行注释不宜过多,不是每行代表都要注释,最好用来解释函数python给函数加注释的操作
04
以下是一些错误使用注释python给函数加注释的方式,一些能直接看到结果的代码最好不要多写注释
特别提示
关键代码,复杂代码使用注释
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
Python中如何添加注释# 单行注释
'''多行注释
多行注释
多行注释
'''
Python中如何添加注释?1. 单行注释
Python编程语言的单行注释常以#最初 ， 单行注释能够作为独自的一行放在被注释代码行之上 ， 也能够放在语句或许表达式之后 。
实例：
# -*- coding: UTF-8 -*-
print ("hello world!"); #您好 ， 国际
2. 多行注释

推荐阅读


上一篇：如何快速推广app话术，app推广话术技巧

下一篇：删除手机历史怎么删除，删除手机历史怎么删除不了