Python編程：使用pydoc生成文檔注釋

pydoc是python自帶的一個文檔生成工具，可以提取注釋

如果有三個引號的注釋方法，會優(yōu)先使用三個點(diǎn)的注釋，其次才展示#號的注釋

示例使用的代碼pydoc_demo.py，包含一個函數(shù)，一個類

# -*- coding: utf-8 -*- # @Date : 2018-10-30 # @Author : Peng Shiyu """ 這個文檔注釋pydoc的示例 """ # 函數(shù)名上方的文字 def func(): """ 函數(shù)名下方的注釋 @return: None """ print("hello") # 類名上方的文字 class Demo(): """ 類名下方的文字 """ # 類中方法上方的文字 def hello(self): """ 類中方法下方的文字 @return: None """ print("hello")

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

生成文檔

$ pydoc pydoc_demo > doc.md

1

將文檔重定向到doc.md文件中，內(nèi)容如下

Help on module pydoc_demo: NAME pydoc_demo - 這個文檔注釋pydoc的示例 CLASSES builtins.object Demo class Demo(builtins.object) | 類名下方的文字 | | Methods defined here: | | hello(self) | 類中方法下方的文字 | @return: None | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) FUNCTIONS func() 函數(shù)名下方的注釋 @return: None FILE /demo/pydoc_demo.py

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

生成html

$ pydoc -w pydoc_demo

1

出現(xiàn)新文件pydoc_demo.html

顏色看上去很鮮艷

參考

pydoc用法

Python

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。