关于python函数自动注释的信息
python注释有哪些方法？
1.单行注释
公司主营业务：成都网站制作、网站建设、移动网站开发等业务。帮助企业客户真正实现互联网宣传，提高企业的竞争能力。创新互联是一支青春激扬、勤奋敬业、活力青春激扬、勤奋敬业、活力澎湃、和谐高效的团队。公司秉承以“开放、自由、严谨、自律”为核心的企业文化，感谢他们对我们的高要求，感谢他们从不同领域给我们带来的挑战，让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。创新互联推出噶尔免费做网站回馈大家。
Python编程语言的单行注释常以#开头，单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或者表达式之后。
实例：
# -*- coding: UTF-8 -*-
print("hello world!"); #您好，世界
2.多行注释
Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记，而实际上这是多行字符串的书写方式，并不是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 多行注释
注释是每一个程序必要的部分，也是一个好程序员的习惯，有以下3种方式：
"""注视内容"""，这一种最强大;
快捷键Alt + 3，需要首先选中要注释的行；
自己写一个函数，然后把内容丢进去，自动添加#。
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 程序有什么好的自动从注释生成文档的方法
用Sphinx
以win32系统为例，最简单的安装方式是在Dos下输入如下代码
pip install -U sphinx
安装好了之后，用最简单的半自动生成API文档的方式进行
例如：你的python安装在C:\python27， 想要给flask包自动制作文档，制作完成的文档放在C:\python_doc\flask的文件夹
代码如下：
sphinx-apidoc -F -o C:\python_doc\flask C:\python27\lib\site-packages\
（此处-o应紧跟输出文件夹，不然会产生一个-F的文件夹，多谢@Hyacz）
然后进入C:\python_doc\flask文件夹
cd C:\python_doc\flask
此文件夹下有一个make.bat文件，再执行一下
make html
然后就能在\_build\html文件夹中看到生成好的文档了，还支持查找的功能
文章题目：关于python函数自动注释的信息
网站链接：http://6mz.cn/article/hioggd.html