問(wèn)題描述

我是一個(gè)新手，以前從來(lái)沒(méi)有發(fā)布過(guò)python程序。最近老師讓我寫(xiě)了兩個(gè)python小模塊，一個(gè)是將pdf轉(zhuǎn)為txt,另一個(gè)是計(jì)算轉(zhuǎn)好的txt文檔的相似度。我寫(xiě)好了并且也知道如何打包成第三方庫(kù)，但是不知道配套的文檔應(yīng)該怎么寫(xiě)？我在網(wǎng)上也查了一下，有的人說(shuō)’’’注釋里的內(nèi)容就是文檔（這個(gè)注釋我都認(rèn)真寫(xiě)了），但是不知道是不是還要在包里放一個(gè)txt文件，寫(xiě)一寫(xiě)不同模塊不同函數(shù)的用法，還是怎么樣？謝謝各位了，我真的是不知道這個(gè)文檔咋搞...

問(wèn)題解答

sphinx

我猜你也用過(guò)git，類似于git project中的readme 文件，看兩個(gè)開(kāi)源項(xiàng)目是怎么寫(xiě)的，寫(xiě)readme的目的，大概就是幫助別人知道這個(gè)項(xiàng)目是什么，能干什么，如何使用，注意要點(diǎn)，差不多就醬

模塊.py

’’’這是模塊文檔’’’pass

>>> import 模塊>>> help(模塊)Help on module 模塊:NAME 模塊 - 這是模塊文檔FILE d:python34模塊.py>>>