使 Emacs ESS 遵循 R 风格指南

Question

我已经使用 Emacs/ESS 有一段时间了，并且我熟悉 Hadley 的 R 风格建议。我想遵循 ESS 中的这些约定，例如运算符周围的那些漂亮空格、逗号后面和 if 语句之后、大括号之前的空格等。

有没有人愿意遵循这个风格指南？恕我直言，官方的风格推荐相当谦虚，他们对风格只字未提。 Google R 风格指南 与我的指南太相似当我用 JavaScript 编码时使用，所以这是一个禁忌。

长话短说：是否有任何具有 (e)LISP 技能的人愿意为 ESS 实施（Hadley 的）风格指南？

Answer 1

我不写 Elisp，而且我不同意 Hadley 关于下划线风格优点的观点。此外，Hadley 仍然迷失在不使用 OneTrueEditor 的沙漠中，所以我们不能指望他在这个问题上提供任何帮助。

但如果您愿意关注 R Core 而不是 Hadley，下面是 R 内部手册，第 8 节“R 编码标准” 建议。对我来说，R Core 首先定义了 R 风格。 Google 和 Hadley 的风格是很好的次要推荐。

无论如何，回到 Elisp。以下内容多年来一直为我们提供了良好的服务，而且我确实喜欢这样一个事实：基本的 R 行为与 Emacs C++ 风格类似，因为我碰巧经常查看这两种模式下的代码。

[...]

以允许的方式编写代码也很重要
其他人才能理解它。这对于修复特别有帮助
问题，包括使用自描述变量名称，
注释代码，并正确格式化它。 R 核心团队
建议对 R 和 C 使用基本缩进 4（并且大多数
可能还有 Perl) 代码，以及 2 个 Rd 格式的文档。 Emacs
（21或更高版本）用户可以通过输入来实现这种缩进样式
在其启动文件之一中包含以下内容，并使用自定义
将c-default-style'设置为“bsd”'并将c-basic-offset'设置为4'。）

<前><代码> ;;; ESS
（添加钩子'ess-模式钩子
（拉姆达（）
（ess-set-style 'C++' 安静）
;;因为
;; DEF GNU BSD K&R C++
;; ess 缩进级别 2 2 8 5 4
;; ess-继续语句-偏移量 2 2 8 5 4
;; ess 大括号偏移 0 0 -8 -5 -4
;; ess-arg-函数偏移 2 4 0 0 0
;; ess 表达式偏移量 4 2 8 5 4
;; ess-else-偏移 0 0 0 0 0
;; ess-闭括号-偏移 0 0 0 0 0
（添加钩子'本地写入文件钩子
（拉姆达（）
（ess-nuke-尾随空白）））））
(setq ess-nuke-trailing-whitespace-p '询问)
;;甚至
;; (setq ess-nuke-trailing-whitespace-p t)
;;;珀尔
(add-hook 'perl-mode-hook
(lambda () (setq perl 缩进级别 4)))

（Emacs 的 C 和 R 模式的“GNU”样式使用基本缩进
2、已确定无法清晰显示结构
使用窄字体时就足够了。）

我认为我经常做的唯一添加是遵循最后一个注释掉的片段：

;; or even
(setq ess-nuke-trailing-whitespace-p t)

如果您确实需要使用下划线进行编码，您当然可以关闭下划线切换。

Answer 2

对于 ESS 的开发版本（将于 2015 年 9 月发布），只需添加到 ess-mode-hook 即可：

(ess-set-style 'RStudio)

RStudio 还具有默认设置的“垂直对齐参数”复选框。如果您想在未选中此设置时重现该行为（如 Hadley 的代码中所示），则需要将 ess-offset-arguments 更改为 prev-line：

(setq ess-offset-arguments 'prev-line)

请如果您发现 ESS 和RStudio 缩进。

Answer 3

Hadley 指南的优点是在运算符周围留出空间（除了 / 周围）

有一个 smart -operator 包几乎为每个操作员实现了它。

这是我的设置（取消注释您要使用的运算符）：

(setq smart-operator-mode-map
  (let ((keymap (make-sparse-keymap)))
    (define-key keymap "=" 'smart-operator-self-insert-command)
    ;; (define-key keymap "<" 'smart-operator-<)
    ;; (define-key keymap ">" 'smart-operator->)
    ;; (define-key keymap "%" 'smart-operator-%)
    (define-key keymap "+" 'smart-operator-+)
    ;; (define-key keymap "-" 'smart-operator--)
    ;; (define-key keymap "*" 'smart-operator-*)
    ;; (define-key keymap "/" 'smart-operator-self-insert-command)
    (define-key keymap "&" 'smart-operator-&)
    (define-key keymap "|" 'smart-operator-self-insert-command)
    ;; (define-key keymap "!" 'smart-operator-self-insert-command)
    ;; (define-key keymap ":" 'smart-operator-:)
    ;; (define-key keymap "?" 'smart-operator-?)
    (define-key keymap "," 'smart-operator-,)
    ;; (define-key keymap "." 'smart-operator-.)
    keymap)
  "Keymap used my `smart-operator-mode'.")

另请参阅有关 R 样式的精彩讨论 此处。

[编辑] 我还对全局变量使用 R 代码事实上的驼峰命名风格。局部变量的名称用下划线分隔 - 很容易区分。

emacs 中有一个特殊的 subword 模式，它重新定义了用于大写子词的所有编辑和导航命令

(global-subword-mode)

Answer 4

与 OP 具​​有相同的风格偏好，我跳到这里，感谢 @lionel 的有效建议，但我在 ~/emacs.d/init.el 中设置 RStudio 风格时遇到了问题:

(ess-set-style 'RStudio)

Emacs/ESS 拒绝应用样式（4 空格缩进而不是 2 空格，这里不讨论样式:)）。

我对新手的建议是，在 ~/emacs.d/init.el 中使用以下钩子

(add-hook 'find-file-hook 'my-r-style-hook)
(defun my-r-style-hook ()
  (when (string-match (file-name-extension buffer-file-name) "[r|R]$")
    (ess-set-style 'RStudio)))

即可解决问题。

Answer 5

风格指南的另一个组成部分到目前为止还没有涉及到
是函数跨多行运行时的缩进。风格指南
说要使用缩进，

long_function_name <- function(a = "a long argument", 
                               b = "another argument",   # X
                               c = "another long argument") {
  # As usual code is indented by two spaces.
}

但使用任何默认样式似乎都会将行 X 缩进一些固定的值
空格数而不是最多 (。解决方案是 设置
ess-arg-function-offset 到一些非数字，例如，

(set 'ess-arg-function-offset t)

这应该放置在类似于@Dirk Eddelbuettel 的答案的模式挂钩中。此外，它必须在任何对 ess-set-style 的调用之后进行，否则它将被覆盖。