請問寫好python模組以後,文件怎麼寫?
黄舟
黄舟 2017-05-24 11:35:07
0
3
570

我是一個新手,以前從來沒有發布過python程式。
最近老師讓我寫了兩個python小模組,一個是將pdf轉為txt,另一個是計算轉好的txt文檔的相似度。我寫好了也知道如何打包成第三方函式庫,但是不知道配套的文件該怎麼寫?
我上網也查了一下,有的人說'''註釋裡的內容就是文檔(這個註釋我都認真寫了),但是不知道是不是還要在包裡放一個txt文件,寫一寫不同模組不同函數的用法,還是怎麼樣?
謝謝各位了,我真的是不知道這個文檔咋搞...

黄舟
黄舟

人生最曼妙的风景,竟是内心的淡定与从容!

全部回覆 (3)
Ty80

獅身人面像

    仅有的幸福

    我猜你也用過git,類似git project中的readme 文件,看兩個開源專案是怎麼寫的,寫readme的目的,大概就是幫助別人知道這個專案是什麼,能幹什麼,如何使用,注意重點,差不多就醬

      漂亮男人

      範例:

      模块.py

      ''' 这是模块文档 ''' pass
      >>> import 模块 >>> help(模块) Help on module 模块: NAME 模块 - 这是模块文档 FILE d:\python34\模块.py >>>
        最新下載
        更多>
        網站特效
        網站源碼
        網站素材
        前端模板
        關於我們 免責聲明 Sitemap
        PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!