Question

假设我有一个Erlang函数，带有spec。

-spec foo(integer(), string()) ->
      boolean().
foo(_Integer, _String) ->
      true.

我的梦想是自动从Emacs中的这些信息中生成edoc。生成的代码应如下所示：

%%--------------------------------------------------------------------
%% @doc
%% Your description goes here
%% @spec foo(_Integer::integer(), _String::string()) ->
%%%      boolean()
%% @end
%%--------------------------------------------------------------------
-spec foo(integer(), string()) ->
      boolean().
foo(_Integer, _String) ->
      true.

是否已存在类似功能？

Answer 1

我不知道Erlang，但这可能会让你开始：

编辑：更近，但只有当args在同一行时才会起作用：（

编辑：现在似乎在不同的行上为args工作

(defun my-erlang-insert-edoc ()
  "Insert edoc."
  (interactive)
  (save-excursion
    (when (re-search-forward "^\\s *-spec\\s +\\([a-zA-Z0-9_]+\\)\\s *(\\(\\(.\\|\n\\)*?\\))\\s *->[ \t\n]*\\(.+?\\)\\." nil t)
      (let* ((beg (match-beginning 0))
             (funcname (match-string-no-properties 1))
             (arg-string (match-string-no-properties 2))
             (retval (match-string-no-properties 4))
             (args (split-string arg-string "[ \t\n,]" t)))
        (when (re-search-forward (concat "^\\s *" funcname "\\s *(\\(\\(.\\|\n\\)*?\\))\\s *->") nil t)
          (let ((arg-types (split-string (match-string-no-properties 1) "[ \t\n,]" t)))
            (goto-char beg)
            (insert "%%-----------------------------------------------------------------------------\n")
            (insert "%% @doc\n")
            (insert "%% Your description goes here\n")
            (insert "%% @spec " funcname "(")
            (dolist (arg args)
              (insert (car arg-types) "::" arg)
              (setq arg-types (cdr arg-types))
              (when arg-types
                (insert ", ")))
            (insert ") ->\n")
            (insert "%%       " retval "\n")
            (insert "%% @end\n")
            (insert "%%-----------------------------------------------------------------------------\n")))))))

Answer 2

CEDET套件在某种程度上支持了Erlang很长一段时间。较早版本的CEDET，例如1.0pre3或其附近，也有edoc支持自动生成类似于您上面讨论的注释。评论生成系统最近发生了变化，因此支持不再存在，因此，想要通过CEDET子包SRecode工作的新评论生成系统的模板的人会很棒。不需要了解Emacs Lisp。

http://cedet.sourceforge.net/

http://cedet.sourceforge.net/codegen.shtml

Emacs中的Erlang Edoc

2 个答案: