r - 如何在 R 中为代码创建内容索引

Question

对于我的工作，我必须编写超过 600 行的脚本。让我的同事阅读我的脚本很重要，但我注意到，即使在阅读我自己的代码时，我也需要滚动很多次才能找到某个函数。

问题不在于代码丑陋或没有注释——每一行都有注释解释正在做什么以及为什么。它也是有组织的——它遵循一个非常可预测的结构。我正在努力的是所有垂直滚动。似乎过时了。当我在写 word 或 latex 文档时，我可以创建被软件识别为索引点的标题。然后，这些索引点会显示在目录中。

我可以在 R 中做类似的事情吗？是否有任何编程语言允许像这样索引点？维基百科也这样做，例如链接 https://en.wikipedia.org/wiki/Meteorological_history_of_Hurricane_Patricia#Peak_strength会将您带到有关飓风峰值强度的段落。

Answer 1

如果你使用 RStudio，你可以这样做。您需要使用这样的注释并显示文档大纲(在源代码旁边)

#library----

#some code---- 


#example----