python注释文档

① 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有哪几种注释方式

python语言快捷注释

单行注释：#注释内容，也可以放到代码行末
多行注释： '''注释内容'''

快捷键注释：
1、注释多行代码
选中想要注释的N行代码，直接Ctrl+/ 即可注释
2、取消注释多行代码
选中想要取消注释的N行代码，直接Ctrl+/ 即可注释

③ python代码的注释有几种

python代码的注释有两种。
一、python单行注释符号(#)
python中单行注释采用#开头，示例：#thisisacomment。
二、批量、多行注释符号
多行注释是用三引号，例如：输入''''''或者""""，将要注释的代码插在中间。

Python由荷兰数学和计算机科学研究学会的吉多·范罗苏姆于1990年代初设计，作为一门叫做ABC语言的替代品。Python提供了高效的高级数据结构，还能简单有效地面向对象编程。
Python语法和动态类型，以及解释型语言的本质，使它成为多数平台上写脚本和快速开发应用的编程语言，随着版本的不断更新和语言新功能的添加，逐渐被用于独立的、大型项目的开发。"

④ python如何批量注释

如果是多行注释，可在每行注释前面加“#”号；也可用3个双引号括起来；还可以用3个单引号括起来。另一种方法，选中要注释的代码，然后按“Ctrl+/”键即可批量注释。

⑤ 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 程序有什么好的自动从注释生成文档的方法

用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中的注释

python中的注释：

1、单行注释（行注释）

Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或表达式之后。

2、多行注释（块注释）

当注释内容过多，导致一行无法显示时，就可以使用多行注释。Python中使用三个单引号或三个双引号表示多行注释。

注意

注释不是越多越好。对于一目了然的代码，不需要添加注释。

对于复杂的操作，应该在操作开始前写上相应的注释。

对于不是一目了然的代码，应该在代码之后添加注释。

绝对不要描述代码。一般阅读代码的人都了解Python的语法，只是不知道代码要干什么。

更多Python基础知识，请转到：零基础入门学习python！！

⑧ python如何进行批量注释

python批量注释的两种方法：1、选中要注释的代码，使用【Ctrl+/】快捷键多行注释；2、将需要注释的部分代码用三个双引号或者三个多引号括起来多行注释。
选中要注释的代码，按住【Ctrl+A】快捷键全选，再按住【Ctrl+/】快捷键多行注释。
将需要注释的部分代码用三个双引号或者三个多引号括起来多行注释。
推荐课程：Python入门与进阶教学视频（极客学院）