使用 yasnippet 进行框式注释

Question

我希望编写一个 yasnippet 模板，该模板允许我添加许可证标头Emacs 中的脚本缓冲区。有点像 this，但有一点改进：

1. 标头需要包含每个用户的数据，例如作为版权所有者的日期姓名和电子邮件， 可以通过嵌入式 elisp 扩展获得 来自 yasnippet。
2. 需要根据文件当前所处的编程模式使用语法对标头进行注释。已经有 一个要点完成这一切的代码片段。基本上，它相当于在代码片段的末尾嵌入 (comment-region (point-min) (point)) 。
3. 现在，我想将评论样式更改为方框。请参阅 emacs 文档以了解 comment-style 变量，或者，如果您想查看框式注释的外观，只需在活动的对象上调用 Mx comment-box区域：它使用正确的选项调用 comment-region 。

第一种方法是通过将上一个代码片段的末尾修改为来设置样式：

(let ((comment-style 'box))
            (comment-region (point-min) (point)))

不幸的是，缩进搞砸了，并且我的盒子不是矩形。如果我从片段开始：

Copyright (c) ${1:`(nth 5 (decode-time))`}
All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted`
      (let ((comment-style 'box))
            (comment-region (point-min) (point)))`

该片段的扩展“打破了盒子”（我正在使用 ocaml 注释语法调试此片段，但这并不重要）：

(**************************************************************)
(* Copyright (c) 2010                                    *)
(* All rights reserved.                                       *)
(*                                                            *)
(* Redistribution and use in source and binary forms, with or *)
(* without modification, are permitted     *)
(**************************************************************)

• 起初我认为第二行是根据预扩展嵌入代码，但在这种情况下，它应该使该行的最后一个 *) 过早出现 25 个空格，而不是 4 个。
• 如果它基于 no 缩进如果文本出现在嵌入点，则最终的*) 应该到达 4 个空格，晚了，而不是很快。
• 最后，我不明白最后一行发生了什么，其中没有嵌入代码扩展：通常我从带有短句的段落中获取方形注释框没有任何问题最后一行（使用 comment-box 或本问题第一个注释块中的 elisp 函数。

我尝试在代码片段扩展后进行注释，以避免任何副作用，通过添加它到 yas/after-exit-snippet-hook，将上面代码片段的最后一个函数替换为：

(add-hook 'yas/after-exit-snippet-hook
      (let ((comment-style 'box))
            (comment-region (point-min) (point))) nil t)

但这也没有帮助，它会给我留下一个扩展钩子，它可以注释所有我想在该缓冲区中使用的片段，我当然不希望

添加一些我试图设置的 东西。 /indent-line 到 fixed，通过

# expand-env: ((yas/indent-line 'fixed))

在我的代码片段的开头添加，但这并没有改变任何东西。关于如何获得矩形盒子有什么想法吗？

---

编辑：我们有一个非常好的答案，以及提议的修复，（荣誉和感谢，Seiji！）但仍然存在一个问题，即如何使其适应想要重用字段的情况，例如重用 $1 in：

Copyright (c) ${1:`(nth 5 (decode-time))`}
All rights reserved.

Redistribution and use in $1, in source and binary forms
`(let ((comment-style 'box))
        (comment-region (point-min) (point-at-eol 0)))`

在这种情况下，模板引擎将在模板扩展时将字段 $1 获得的（可变长度）值（即 2011）复制到最后一行（缩进后），注释行 2 个字符太宽。在编写模板时很难预测应该删除这一行的4个字符。也许字段重用和正确缩进同时要求太多。有没有人看到一种方法可以做到这一点？

Answer 1

将您的代码片段更改为此代码可以修复最后一行。

Copyright (c) ${1:`(nth 5 (decode-time))`}
All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted
`(let ((comment-style 'box))(comment-region (point-min) (point-at-eol 0)))`

请注意，许可证（“...被允许”）和嵌入的 emacs lisp 代码之间有一个换行符。

至于第二行，我将首先解释为什么会发生这种情况，然后提供（丑陋的）修复。当您的代码片段插入到文件中时，嵌入的 Lisp 块将从缓冲区的开头到结尾按顺序求值。这在您的代码片段中意味着当下一个块 (comment-region .. .)，被评估。

因此，comment-region 将第二行视为

Copyright (c) ${1:2011}

So, comment-region 为此字符串添加了足够的空格。然后，模板引擎将 ${1:2011} 转换为 2011，此转换将字符串缩短 5 个字符。这解释了第二行中过早出现 5 个字符的 *)。

解决这种情况的一种方法是在评估 comment-region 后放回 5 个空格 --- 类似于：

Copyright (c) ${1:`(nth 5 (decode-time))`} @
All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted.
`(let ((comment-style 'box))(comment-region (point-min) (point-at-eol 0)))``
(replace-string "@" "      " nil (point-min) (point))`$0

Answer 2

这可能对您有用：

# -*- mode: snippet -*-
# name: param
# key:  param
# --
m.parameter :${1:arg},${1:$(make-string (- 14 (string-width text)) ?\ 
                         )}:${2:type}
gt;

它使用带有功能的镜子来创建定位空白。因此，对您来说，这可能意味着这样的事情：

(* Copyright (c) ${1:2011}${1:$(make-string (- 72 (string-width text)) ?\ )} *)
(* ${2}${2:$(make-string (- 72 (string-width text)))}*)

另一种选择可能是使用 yas/after-exit-snippet-hook，但这似乎已被弃用。 （哦，我的意思是自己过滤文本，你已经尝试过的注释区域更聪明。尝试缩进区域？）

Answer 3

这对我有用：

# -*- mode: snippet -*-
# name: box comment block
# key: bbox
# expand-env: ((yas-after-exit-snippet-hook (lambda () (if (buffer-substring yas-snippet-beg yas-snippet-end) (comment-box yas-snippet-beg yas-snippet-end 1)))))
# --
Copyright (c) ${1:`(nth 5 (decode-time))`}
All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted
$0

我参考了这个问题中的信息在特定片段之后运行函数