我正在尝试向python代码添加示例。
我在哪里放@example filename
,以便它显示在类/模块/包帮助中,目前我只是得到一个示例列表,但没有链接形成classdocs到示例。
我尝试将@example
放在类doc(我使用doxypy来允许文档字符串中的标记),课后,以及@package
之后的文件中的顶部注释。
虽然这是一个紧迫的问题,但还有另一个问题,我可以让doxygen简单地解析示例文件夹中的所有示例,并在不添加标记的情况下在类和示例之间创建自动链接吗?
我有以下结构:projectcode/aTreeOfPackagesAndModules
和examples/aTreeOfPackagesAndModules
。树具有完全相同的布局,每个包的示例文件具有完全相同的路径/文件名,除了projectcode
/ examples
dirs beeing交换。我可以获得arround添加示例标签吗?