栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

如何使用Doxygen记录Python代码

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

如何使用Doxygen记录Python代码

这在doxygen网站上有记录,但在此处进行总结:

您可以使用doxygen来记录您的Python代码。您可以使用Python文档字符串语法:

"""@package docstringdocumentation for this module.More details."""def func():    """documentation for a function.    More details.    """    pass

在这种情况下,注释将由doxygen提取,但您将无法使用任何特殊的doxygen命令。

或者, 您可以(类似于doxygen下的C风格语言)

#
将成员前面第一行的注释标记()加倍:

## @package pyexample#  documentation for this module.##  More details.## documentation for a function.##  More details.def func():    pass

在这种情况下,您可以使用特殊的doxygen命令。没有特定的Python输出模式,但您可以通过将设置

OPTMIZE_OUTPUT_JAVA
为来明显改善结果
YES

老实说,我对两者之间的差异感到有些惊讶-
好像doxygen可以在##块或“”“块中检测到注释时,大部分工作就可以完成,并且您可以在其中使用特殊命令也许他们希望使用“”“的人遵守更多的Python文档实践,而这会干扰特殊的doxygen命令?



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/611243.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号