emacs - 源代码注释中的交叉引用

Question

有时，当您编写程序时，您需要在注释中引用另一个部分/或函数。例如，在下面的代码中，我可以在注释中设置两个 anchor “workaround1”和“workaround2”(在另一个文件中)，并引用相关注释对 ABC 函数进行注释。

// this part does <<workaround1>>
a = 1;
a++;
...

// [[workaround1]] and [[file:c.java::workaround2][2]] can be removed once ABC is fixed
c = ABC();

我有两个问题:

此类引用文献是否有最佳实践？专业程序员如何处理？

是否有用于 emacs 的包，可以通过带有此类注释的源代码注释来促进导航？我正在考虑可以在(最好是任何)语言模式之上工作的组织模式扩展。

我知道关于 Redmine 的类似问题: Can I create a cross-project source reference in redmine?

Answer 1

毫无疑问，有不同的方法可用。有人可能会描述如何使用 org-mode为此，这可能是最常见的方法。我个人使用 linkd.el - 简单的。你可以得到它here .

我在 Emacs-Lisp 文件中使用它，但您可以在任何文本文件中使用它。

标题或命名目的地看起来像这样的纯文本:

;; (@* "常见的辅助函数")

这是针对 Lisp 的，其中 ;开始评论。在您的情况下，您将使用 // ， 我相信。

来自同一文件的链接如下所示:

;; (@> "常用辅助函数")

来自不同文件的链接如下所示:

;; (@file :file-name "foo.el":to "Common helper functions")

但是它们是使用突出显示呈现的，并且没有多余的字符。

目的地如下所示(但突出显示):

* 常用辅助函数

同文件链接如下所示(但突出显示为 Emacs 链接，并使用鼠标悬停突出显示):

> 常用辅助函数

一个不同的文件链接看起来像这样(但突出显示为一个链接，鼠标悬停):

. foo.el : 常用辅助函数