python的函数注释的简单介绍

python注释有哪些方法？

1.单行注释

创新互联公司是一家朝气蓬勃的网站建设公司。公司专注于为企业提供信息化建设解决方案。从事网站开发，网站制作，网站设计，网站模板，微信公众号开发，软件开发，小程序制作，十年建站对成都三维植被网等多个方面，拥有多年建站经验。

Python编程语言的单行注释常以#开头，单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或者表达式之后。

实例：

# -*- coding: UTF-8 -*-

print("hello world!"); #您好，世界

2.多行注释

Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记，而实际上这是多行字符串的书写方式，并不是Python本身提倡的多行注释方法。

实例：

'''

这是多行注释，使用单引号。

这是多行注释，使用单引号。

'''

"""

这是多行注释，使用双引号。

这是多行注释，使用双引号。

"""

python中函数定义

1、函数定义

①使用def关键字定义函数

②

def 函数名(参数1.参数2.参数3...):

"""文档字符串，docstring，用来说明函数的作用"""

#函数体

return 表达式

注释的作用：说明函数是做什么的，函数有什么功能。

③遇到冒号要缩进，冒号后面所有的缩进的代码块构成了函数体，描述了函数是做什么的，即函数的功能是什么。Python函数的本质与数学中的函数的本质是一致的。

2、函数调用

①函数必须先定义，才能调用，否则会报错。

②无参数时函数的调用：函数名()，有参数时函数的调用：函数名(参数1.参数2.……)

③不要在定义函数的时候在函数体里面调用本身，否则会出不来，陷入循环调用。

④函数需要调用函数体才会被执行，单纯的只是定义函数是不会被执行的。

⑤Debug工具中Step into进入到调用的函数里，Step Into My Code进入到调用的模块里函数。

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 语句，缩进以及注释，在本节的最后一部分，还会介绍作为一种特殊类型的 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单行注释符号(#)：井号(#)常被用作单行注释符号，在代码中使用#时，它右边的任何数据都会被忽略，当做是注释。print 1 #输出1，#号右边的内容在执行的时候是不会被输出的。

二、批量、多行注释符号：在python中也会有注释有很多行的时候，这种情况下就需要批量多行注释符了。多行注释是用三引号''' '''包含的。

python正则表达式的注释方法：学过正则都知道，那简直是天书，为了提高正则的可读性，正则表达式中提供了X(VERBOSE): 详细模式。这个模式下正则表达式可以是多行，忽略空白字符，并可以加入注释。

Python

是完全面向对象的语言。函数、模块、数字、字符串都是对象。并且完全支持继承、重载、派生、多继承，有益于增强源代码的复用性。Python支持重载运算符和动态类型。相对于Lisp这种传统的函数式编程语言，Python对函数式设计只提供了有限的支持。有两个标准库(functools, itertools)提供了Haskell和Standard ML中久经考验的函数式程序设计工具。

python所有内置函数的定义详解

1、定义函数

函数是可重用的程序。本书中已经使用了许多内建函数，如len()函数和range()函数，但是还没自定义过函数。定义函数的语法格式如下：

def 函数名(参数):

函数体

定义函数的规则如下：

①关键字def用来定义一个函数，它是define的缩写。

②函数名是函数的唯一标识，函数名的命名规则遵循标识符的命名规则。

③函数名后面一定要紧跟着一个括号，括号内的参数是可选的，括号后面要有冒号。

④函数体(statement)为一个或一组Python语句，注意要有缩进。

⑤函数体的第一行可以有文档字符串，用于描述函数的功能，用三引号括起来。

按照定义规则，可以定义第一个函数了：

def hello_world():

...     print('Hello,world!')   # 注意函数体要有缩进

...

hello_world()

Hello,world!

这个函数不带任何参数，它的功能是打印出“Hello,world!”。最后一行代码hello_world()是调用函数，即让Python执行函数的代码。

2、全局变量和局部变量

全局变量是定义在所有函数外的变量。例如，定义一个全局变量a，分别在函数test1()和test2()使用变量a：

a = 100   # 全局变量

def test1():

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

test2()

100

定义了全局变量a之后，在函数test1()和test2()内都可以使用变量a，由此可知，全局变量的作用范围是全局。

局部变量是在函数内定义的变量，除了用关键字global修饰的变量以外。例如，在函数test1()内定义一个局部变量a，分别在函数外和另一个函数test2()内使用变量a：

def test1():

...     a = 100   # 局部变量

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

print(a)

Traceback (most recent call last):

File "stdin", line 1, in module

NameError: name 'a' is not defined

test2()

Traceback (most recent call last):

File "stdin", line 1, in module

File "stdin", line 2, in test2

NameError: name 'a' is not defined

Python解释器提示出错了。由于局部变量a定义在函数test1()内，因此，在函数test1()内可以使用变量a，但是在函数外或者另一个函数test2()内使用变量a，都会报错，由此可见，局部变量的作用范围是定义它的函数内部。

一般情况下，在函数内声明的变量都是局部变量，但是采用关键字global修饰的变量却是全局变量：

def test1():

...     global a   # 全局变量

...     a = 100

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

print(a)

100

test2()

100

这个程序与上个程序相比，只是在函数test1()中多了一行代码“global a”，程序便可以正确运行了。在函数test1()中，采用关键字global修饰了变量a之后，变量a就变成了全局变量，不仅可以在该函数内使用，还可以在函数外或者其他函数内使用。

如果在某个函数内局部变量与全局变量同名，那么在该函数中局部变量会覆盖全局变量：

a = 100   # 全局变量

def test1():

...     a = 200   # 同名局部变量

...     print(a)

...

def test2():

...     print(a)

...

test1()

200

test2()

100

由于在函数test1()中定义了一个与全局变量同名的局部变量a，因此，在函数test1()中全局变量a的值被局部变量覆盖了，但是在函数test2()中全局变量a的值没有被覆盖。

综上所述，在Python中，全局变量保存的数据供整个脚本文件使用;而局部变量只用于临时保存数据，变量仅供局部代码块使用。

当前文章：python的函数注释的简单介绍
文章来源：http://shouzuofang.com/article/hshdgd.html