最近在看webpy的源碼，發(fā)現(xiàn)其模塊的help()輸出非常漂亮：
image.png
作為一個(gè)python初學(xué)者，度娘了一下docstring的具體用法，大部分都說得很簡單，除了_doc_屬性以及單行、多行注釋以外幾乎沒什么詳細(xì)和系統(tǒng)的介紹docstring的寫法。作為程序員必備的基本能力之一，我就在這里練練如何寫好docstring，并將其過程記錄下來以備大家參考。
如何看webpy的docstring
- 下載源碼
webpy的源碼
2.help輸出（Linux）
ln -s 源碼中的web目錄地址 .
python -c "import web;help(web)"
參考材料：help()的實(shí)現(xiàn)
實(shí)戰(zhàn)開始：環(huán)境準(zhǔn)備
1.創(chuàng)建測試包
image.png
其中__init__.py是個(gè)空文件
2.help輸出
python -c "import test_mod;help(test_mod)"
image.png
各種SECTION及對應(yīng)的使用方法
1.NAME與DESCRIPTION
修改__init__.py（左邊）并觀察help的輸出（右邊）：
123.png
注：第三種情況中第二行為空行
2.PACKAGE CONTENTS（自生成）
123.png
3.CLASSES（自生成）
123.png
對于外部能看到的class，help()會(huì)輸出相應(yīng)的信息
圖注：
1.類的繼承關(guān)系
2.類的描述
3.DATA、FUNCTIONS（自生成）
123.png
3.VERSION、DATE、AUTHOR、CREDITS
123.png
