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入門與進階教學視頻（極客學院）