请问写好python模块以后，文档怎么写？

问题描述

问 题

我是一个新手，以前从来没有发布过python程序。
最近老师让我写了两个python小模块，一个是将pdf转为txt,另一个是计算转好的txt文档的相似度。我写好了并且也知道如何打包成第三方库，但是不知道配套的文档应该怎么写？
我在网上也查了一下，有的人说'''注释里的内容就是文档（这个注释我都认真写了），但是不知道是不是还要在包里放一个txt文件，写一写不同模块不同函数的用法，还是怎么样？
谢谢各位了，我真的是不知道这个文档咋搞...

解决方案

我猜你也用过git，类似于git project中的readme 文件，看两个开源项目是怎么写的，写readme的目的，大概就是帮助别人知道这个项目是什么，能干什么，如何使用，注意要点，差不多就酱

这篇关于请问写好python模块以后，文档怎么写？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！