首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何使用Doxygen为Python代码编写文档

如何使用Doxygen为Python代码编写文档
EN

Stack Overflow用户
提问于 2008-09-12 10:26:40
回答 2查看 137.1K关注 0票数 99

我喜欢Doxygen来创建C或PHP代码的文档。我有一个即将到来的Python项目,我想我记得Python没有/* .. */注释,而且还有自己的自我文档工具,这似乎是Python的文档编制方式。

既然我熟悉Doxygen,那么我如何使用它来生成我的Python文档呢?有什么特别需要我注意的吗?

EN

回答 2

Stack Overflow用户

发布于 2009-01-30 21:30:03

Python筛选器允许您以标准doxypy文档字符串格式使用几乎所有的format格式化标记。我用它来记录一个大型的混合了C++和Python的游戏应用程序框架,它工作得很好。

票数 90
EN

Stack Overflow用户

发布于 2008-09-12 21:04:48

据我所知,Sphinx主要是用于格式化独立于源代码编写的文档的工具。

要从Python文档字符串生成API文档,主要的工具是pdocpydoctor。以下是pydoctor为TwistedBazaar生成的API文档。

当然,如果您只是想在处理文档时查看文档字符串,那么在交互式解释器中可以使用"pydoc“命令行工具和help()函数。

票数 21
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/58622

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档