锐客网

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

关于python中函数加注释的信息( 二 )

代码IT技术


一般来说，在
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中如何添加注释?1. 单行注释
Python编程语言的单行注释常以#最初 ， 单行注释能够作为独自的一行放在被注释代码行之上，也能够放在语句或许表达式之后 。
实例：
# -*- coding: UTF-8 -*-
print ("hello world!"); #您好，国际
2. 多行注释
Python中多行注释运用三个单引号(’’’)或许三个双引号(”””)来标记，而实际上这是多行字符串的书写方法，并不是Python本身提倡的多行注释方法 。
实例：
'''
这是多行注释，运用单引号 。
这是多行注释 ， 运用单引号 。
'''
"""
这是多行注释，运用双引号 。
这是多行注释 ， 运用双引号 。
"""
3. 编码注释
在进行Python开发时，需进行编码声明，如选用UTF-8编码，需在源码上方进行 # -*- coding: UTF-8 -*- 声明，从Python3开始，Python默许运用UTF-8编码，所以Python3.x的源文件不需要特别声明UTF-8编码 。
4. 平台注释
如果需要使Python程序运行在Windows平台上，需在Python文件的上方加上 #!/usr/bin/python 注释阐明 。
关于Python中如何添加注释 ， 青藤小编就和您分享到这里了 。如果您对python编程有浓厚的兴趣 ， 希望这篇文章可以为您提供帮助 。如果您还想了解更多关于python编程的技巧及素材等内容，可以点击本站的其他文章进行学习 。
Python函数注解使用有哪些注意事项呢？函数注解是关于用户自定义的函数的完全可选的、随意的元数据信息 。
1.无论 Python 本身或者标准库中都没有使用函数注解python中函数加注释；本节只是描述了语法 。第三方的项目是自由地为文档python中函数加注释，类型检查python中函数加注释，以及其它用途选择函数注解 。
2.注解是以字典形式存储在函数的 __annotations__ 属性中python中函数加注释，对函数的其它部分没有任何影响 。参数注解（Parameter annotations）是定义在参数名称的冒号后面，紧随着一个用来表示注解的值得表达式 。返回注释（Return annotations）是定义在一个 - 后面，紧随着一个表达式，在冒号与 - 之间 。下面的示例包含一个位置参数，一个关键字参数，和没有意义的返回值注释:
def f(ham: 42, eggs: int = 'spam') - "Nothing to see here":
... print("Annotations:", f.__annotations__)

推荐阅读


上一篇：学生带手机的申请怎么写，高中学生带手机申请怎么写

下一篇：画五子棋棋盘java代码，五子棋棋盘画法代码