elisp的注释规范是否需要遵守?

elisp

#1

我又双叒叕叕叕叕叕叕叕叕…… 来问强迫症和伸手问题了……

那么这些老是提示我错误,却也不影响运行的注释规范是为了啥? 比如一个init.el:

;;; init.el --- load all config

;;; Commentary:

;; This file simply sets up the default load path and requires
;; the various modules defined within Emacs Prelude.


;;; Code:

你的代码

;;; init.el ends here

这种格式规范是为了啥?有没有必要遵守?


#2

Flycheck 对于 Elisp 的注释规范严格得有点可笑,Spacemacs 里面是默认关闭的。 这个规范主要是用来写 package 的,配置文件不必太严格。


配置文件出现两条 flycheck 错误,怎么处理?
#3

好吧,我确实关了这个功能…… 另外有人老爱加一句

;;; -*- coding: utf-8 -*-

是为了啥? elisp也有声明编码的需要?


#4

这个是用来声明 本文件 使用utf-8进行存储


#5

只要你的文件里面没非 ASCII 字符就可以不加。


#6

这个是 Emacs 的 File Local Variable,是注释(Magic Comment),不会影响层序执行(可能有些语言的解释器/编译器也会识别它),其它的编辑器/IDE 不会管这些。你还可以设置 Major Mode,Eval 些 Emacs Lisp 表达式等等。