python中的__doc__詳解
參考文獻(xiàn)
[1] https://stackoverflow.com/questions/33066383/print-doc-in-python-3-script
__doc__為模塊字符串，模塊字符串寫在Python文件的第一行，三個(gè)引號(hào)包含起來的字符串。
為什么要寫文檔字符串?
因?yàn)橐?guī)范的書寫文檔字符串可以通過sphinx等工具自動(dòng)生成文檔。
文檔字符串的風(fēng)格有很多。
- Plain
- Epytext
- reStucturedText
- Numpy
風(fēng)格示例
# Plain
def
foo1
(
a
,
b
)
:
"""
"""
return
a
+
b
# reStructuredText
def
foo2
(
a
,
b
)
:
"""
:param a:
:param b:
:return:
"""
return
a
+
b
# Numpy
def
foo3
(
a
,
b
)
:
"""
Parameters
----------
a
b
Returns
-------
"""
return
a
+
b
# Google
def
foo4
(
a
,
b
)
:
"""
Args:
a:
b:
Returns:
"""
return
a
+
b
# Epytext
def
foo
(
a
,
b
)
:
"""
@param a:
@param b:
@return:
"""
return
a
+
b
我們可以在pycharm上進(jìn)行自定義設(shè)置默認(rèn)的文檔字符串風(fēng)格。暫時(shí)推薦 reStructuredTex t吧，緊湊，sphinx御用
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索：z360901061
微信掃一掃加我為好友
QQ號(hào)聯(lián)系： 360901061
您的支持是博主寫作最大的動(dòng)力，如果您喜歡我的文章，感覺我的文章對(duì)您有幫助，請(qǐng)用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧，狠狠點(diǎn)擊下面給點(diǎn)支持吧，站長非常感激您！手機(jī)微信長按不能支付解決辦法：請(qǐng)將微信支付二維碼保存到相冊(cè)，切換到微信，然后點(diǎn)擊微信右上角掃一掃功能，選擇支付二維碼完成支付。
【本文對(duì)您有幫助就好】元
