對python的檔案內注釋 help注釋方法

2022-10-04 19:36:14 字數 1086 閱讀 1500

目的:

在help(模組名)時,能夠看見檔案裡面的注釋。

首先,在檔案的最開頭,如果有個多行注釋(三引號),就會將注釋寫入__doc__變數,在help檢視時,可以看見這個變數。

如果還需要輸出函式,則可以將函式放入__all__變數。

__all__ = ['search','fix','hello','parser']

all裡面www.cppcns.com的元素是唯一的,所以,這裡要避免函式重名。當然,python對函式的過載也不是很提倡……

這樣在python命令列,可以看見注釋了。

比如乙個程式是test02.py,先import它,再看

help(test02)

或者在程式中呼叫print(help(test02))

源**:

#test02.py

"""author:zhao zhenyu

this is an absolute test program.

"""__all__ = ["function1", "function2"]

def function1():

pasdef function2():

"""2nd

"""pass

執**況:

>>> import test02

>>> help(test02)

help on module test02:

name

test02

descript

author:zhao zhenyu

this is an absolute test program.

functions

function1()

function2()

2nddata

__all__ = ['function1', 'function2']

file

c:\users\lenovo\documents\python scr程式設計客棧ipts\python_spider\csdn例子\test02.py

>>>

本文標題: 對python的檔案內注釋 help注釋方法

本文位址:

Python 檔案頭注釋

encoding utf 8是注釋,但 python 看到這句話就知道了接下來應該用 utf 8 對該 py 檔案進行解碼了。如果直接採用 python file.py 的方式執行指令碼的話,有沒有 shebang 都無所謂,因為我們自己直接指定了該指令碼的直譯器,即 python。通常我們認為 u...

python 增加檔案注釋以及函式注釋

毋庸置疑,良好的編碼習慣對於學習一門語言很重要,這樣可以很好的保持 可讀性以及可維護性。的可讀性可以通過 的命名以及注釋體現。當然理想的可讀性良好的 是完全沒有注釋,本身已經具有充分的自明性。目前對於python遵守的pep8 規範,需要進一步的了解和熟悉。首先掌握檔案注釋以及函式注釋。1.檔案注釋...

PHP 去除檔案內的注釋並生成新的資料夾及檔案

去除php 注釋 param string content 內容 return string 去除注釋之後的內容 public function removecomment content 判斷路徑檔案是否存在 不存在則建立 dirname是只當前檔案路徑上一級 public function cr...