doxygen加法示例

2024-09-30 05:26:21 发布

您现在位置:Python中文网/ 问答频道 /正文

我试图在python代码中添加示例。 我必须把@example filename放在哪里,以便它显示在类/模块/包帮助中,此时我只得到一个示例列表,但没有从classdoc到示例的链接。在

我试着把@example放在类doc中(我使用doxypy来允许docstring中的标记),放在类之后,@package后面的文件中top注释的正下方。在

虽然这是一个紧迫的问题,但还有另一个问题,我可以让doxygen简单地解析example文件夹中的所有示例并在类和示例之间创建自动链接而不添加标记吗?在

我有以下结构:projectcode/aTreeOfPackagesAndModules和{}。这些树的布局完全相同,每个包的示例文件的路径/文件名完全相同,除了projectcode/examples目录交换。我可以随意添加示例标记吗?在


Tags: 模块文件代码标记示例package列表doc

热门问题