【问题标题】:Generate link to relevant line of source code生成指向相关源代码行的链接
【发布时间】:2021-02-15 14:13:52
【问题描述】:

我已经用 doxygen 记录了我的代码。生成的文档包括:

  • 我在/** ... */
  • 之间放置的文档页面
  • 包含源代码本身的页面(没有/** ... */ 之间的文档)。

现在我的问题是:有没有一种方法可以生成链接,以便人们可以直接从文档中访问在相关行上打开源代码的页面?


直观地展示我想要获得的东西:

  1. 我想要一个“转到源代码”按钮(显示为红色,并在此处用箭头装饰)。

  2. 这会让我进入源代码的右行(可能带有突出显示,如此处所示)。

【问题讨论】:

  • 问题有点不清楚,最好添加一个小示例并提及您使用的版本。问题是您想在源代码中链接哪种类型的实体?目前,据我所知,没有可能做到这一点。
  • @albert 谢谢你的评论。我进行了编辑以使事情更清楚。你同意这种情况吗?
  • 唯一的方法也是假设您只使用 HTML 输出将使用指向上述行的 HTML 链接,因为源代码中的每一行都有一个类似 <a name="l00012"> 的名称,尽管这非常容易出错,因为当源代码更改时,行号可能会更改,因此链接将指向另一个地方。这占了特定的行,但是当您启用SOURCE_BROWSER=YES(可能还有STRIP_CODE_COMMENTS=NO)时,您将获得源代码详细描述中的链接。另请查看\snippet 命令和INLINE_SOURCES 的设置。
  • @albert 谢谢!事实上,这是一个容易出错且劳动密集型的解决方法。我确实希望有一个我没有找到的 doxygen 选项。我会提出问题

标签: doxygen


【解决方案1】:

以下选项正是这样做的:

SOURCE_BROWSER = YES

谢谢@albert!

【讨论】:

    猜你喜欢
    • 2016-09-17
    • 1970-01-01
    • 2020-12-18
    • 1970-01-01
    • 2010-12-10
    • 2014-03-21
    • 1970-01-01
    • 1970-01-01
    • 2015-05-07
    相关资源
    最近更新 更多