锐客网

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

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

IT技术年龄

Python语句怎样注释？1.单行注释
Python编程语言的单行注释常以#开头，单行注释可以作为单独的一行放在被注释代码行之上 ， 也可以放在语句或者表达式之后 。
实例：
# -*- coding: UTF-8 -*-
print("hello world!"); #您好，世界
2.多行注释
Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记，而实际上这是多行字符串的书写方式，并不是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有哪几种注释方式python中python添加函数注释的注释有单行注释和多行注释：
1、单行注释(行注释)
python中使用#表示单行注释 。单行注释可以作为单独的一行放在被注释代码行之上python添加函数注释，也可以放在语句或表达式之后 。
比如：
# 这是一个注释
print("Hello, World!")
①当单行注释作为单独的一行放在被注释代码行之上时python添加函数注释，为python添加函数注释了保证代码的可读性，建议在#后面添加一个空格，再添加注释内容 。

推荐阅读


上一篇：sqlserver查询出来的直接修改，sql查询后修改

下一篇：区域根服务器，根域服务器的作用