Python文档生成工具pydoc使用介绍
来源:互联网 发布:lol龙虾皮肤淘宝价多少 编辑:程序博客网 时间:2024/04/25 20:44
这篇文章主要介绍了Python文档生成工具pydoc使用介绍,本文讲解了基本用法、获取帮助的方法、生成的文档效果图等内容,需要的朋友可以参考下。
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc.
pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!
pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!
【用法】
Windows下:
D:\>python -m pydoc <modulename> # 比如说: python -m pydoc math -m参数:Python以脚本的方法运行模块
Linux/Unix下:
$ pydoc <modulename> # 比如说: pydoc
【帮助】
$ pydoc -h pydoc - the Python documentation tool pydoc <name> ... Show text documentation on something. <name> may be the name of a Python keyword, topic, function, module, or package, or a dotted reference to a class or function within a module or module in a package. If <name> contains a '/', it is used as the path to a Python source file to document. If name is 'keywords', 'topics', or 'modules', a listing of these things is displayed. pydoc -k <keyword> Search for a keyword in the synopsis lines of all available modules. pydoc -p <port> Start an HTTP server on the given port on the local machine. pydoc -w <name> ... Write out the HTML documentation for a module to a file in the current directory. If <name> contains a '/', it is treated as a filename; if it names a directory, documentation is written for all the contents.
【参数 -p】在本地机器上,按照给定的端口启动HTTP,
D:\>python -m pydoc -p 1234 #比如说: 端口为1234pydoc server ready at http://localhost:1234/pydoc server stopped
0 0
- Python文档生成工具pydoc使用介绍
- Python文档生成工具pydoc使用介绍
- Python文档生成工具pydoc使用介绍
- Python文档生成工具pydoc
- Python文档生成工具pydoc
- Python文档生成工具pydoc
- 使用Pydoc生成文档
- python文档生成工具pydoc在网页上查看的方法
- python查看帮助文档的命令--pydoc
- python学习-错误-pydoc不能使用
- Doxygen代码文档生成工具简单介绍与使用
- Python学习笔记-pydoc的使用(待补充)
- Python pydoc模块
- python获取pydoc
- python查看pydoc
- Pydoc简单使用
- 使用JavaDoc工具,生成源码文档
- Doxygen文档生成工具的使用
- 对计算机网络考研知识点归纳(不断更新中T)
- 如何破解WebLogic管理密码
- 完美配置Tomcat的HTTPS
- 设计模式(10)--组合模式
- 第3讲 示例1-三角形
- Python文档生成工具pydoc使用介绍
- redis3.0 运维(动态增加、删除、重新分配节点)
- 项目过程中遇到的问题及小知识点总结
- 字符设备之globalmem
- 从0开始学习SpringBoot-第2天
- Merge Two Sorted Lists
- Android官方开发文档Training系列课程中文版:支持不同的设备之支持不同的语言
- android:layout_weight属性的工作原理
- android的抽屉控件SlidingDrawer的使用