Python 文档化开发试水 -- epydoc

本文详细介绍了epydoc的安装过程与基本用法,并通过实际案例展示了如何使用epydoc生成文档,包括从源文件中解析注释并生成HTML文档的过程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

项目主页:http://sourceforge.net/projects/epydoc

下载-->解压-->打开readme.txt,查看使用说明

Installing
wangs-MacBook-Pro:epydoc-3.0.1 wangjiankui$ sudo su
Password:
sh-3.2# 
sh-3.2# pwd
/Users/wangjiankui/Downloads/epydoc-3.0.1
sh-3.2# ls
LICENSE.txt	PKG-INFO	build		epydoc		scripts
Makefile	README.txt	doc		man		setup.py
sh-3.2# python setup.py install
running install
running build
running build_py
........

代码修改参考:http://blog.youkuaiyun.com/largetalk/article/details/6950435
     ---参考博客写的太规范了,作为初学者我只是给脚本和重要函数加了注释,然后makefile都没写, epydoc --help

查看了下参数,

epydoc --html -v -o docstrings XX.py
直接生成了....


后续继续摸索并规范.....



转载于:https://my.oschina.net/wangjiankui/blog/108877

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值