6

假设我有一个带有规范的 Erlang 函数。

-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.

是否已经存在类似的功能？

4

2 回答 2

5

我不知道 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")))))))
于 2010-04-01T14:48:17.757 回答
1

CEDET 套件在一定程度上支持 Erlang 已经有一段时间了。较早版本的 CEDET，例如 1.0pre3 或更高版本也支持自动生成类似于您上面讨论的注释的 edoc。评论生成系统最近发生了变化，因此不再提供支持，因此如果有人想为通过 CEDET 子包 SRecode 工作的新评论生成系统提供模板，那就太好了。不需要 Emacs Lisp 知识。

http://cedet.sourceforge.net/

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

于 2010-04-02T00:44:32.527 回答