【问题标题】:Different Colored Comments不同颜色的评论
【发布时间】:2021-10-30 07:44:41
【问题描述】:

关于注释代码美学(颜色)的简单问题: 我最近在某人的评论代码中注意到,他们的部分评论颜色在使用@ 符号时发生了变化。在尝试了它之后,我注意到你还需要在 octothorp (#) 之后添加一个撇号 ('),如下所示:

#' @text 
      ^--- This turned orange!

由于我是一个详细的评论者,如果可以的话,我很乐意为我的 cmets 添加颜色。我知道部分原因是我的全局 IDE (RStudio) 选项,但我之前从未见过任何改变评论颜色的东西,所以我只是好奇:

  1. 为什么会发生这种情况?我只看到@ 在处理需要进一步规范的大型、更复杂的对象时使用 => 例如。 LargeObject@data$variable
  2. 还有其他触发颜色变化的符号吗?当然也有引号 (""),但引号在用 octothorp (#) 注释掉时不会改变颜色。
  3. 另外,在图像(底行)上,是否有一种方法可以开始和结束注释,然后是命令,都在一行上? => 例如。 #comment# print(summary(df))

【问题讨论】:

    标签: r colors rstudio comments


    【解决方案1】:
    1. 您看到的特殊突出显示(在#' @ 之后突出显示的单词)特定于roxygen markup(R 的文档生成系统)。我不知道为什么该类别似乎没有列出/主题(请参阅#2)。

    2. RStudio 语法高亮颜色为customizable(您可以edit these themes visually),但根据链接中记录的内容,“cmets”似乎只有一个类别。

    3. 这个问题与 R 解析器有关,而不是与 RStudio 突出显示系统有关。所以答案是“不”;从一行的第一个# 到换行符的所有内容都被视为注释,没有例外。 原则上您可以调整 RStudio 高亮引擎以识别 cmets 中的各种分隔符并以不同方式显示材料,但您不能创建内联 cmets(就像 C 中的 /* */ 一样)无需修改 R 解析器。

    【讨论】:

    • 知道了,谢谢!两个后续问题:关于 roxygen 标记的链接,我读到这些特殊的 cmets 旨在帮助自动写入 .rd 文件(从我读到的内容是基本上是记录包中对象的标准)。那么:(1)这种注释语法主要是为包开发人员准备的吗? (2) 如果是这样,那么只要我不需要为我正在处理的工作生成 .rd 文件,那么使用#' @ 只是为我的 cmets 添加更多颜色是无害的?
    • (1) 是的(尽管如果您的读者是经验丰富的 R 开发人员,他们可能会感到困惑)
    • 好的,再次感谢你,Ben,我很感激!
    猜你喜欢
    • 1970-01-01
    • 2017-11-29
    • 1970-01-01
    • 2012-03-30
    • 2021-04-11
    • 2018-01-16
    • 1970-01-01
    • 2015-09-13
    • 2011-11-09
    相关资源
    最近更新 更多