事前入力されたdoxygenコメントを生成するyasnippetはありますか?


10

次のC ++関数の場合:

bool importantStuff(double a, double b);

おそらくタグなしで、次のスニペットを出力します。

/**
 * <Insert description of importantStuff>
 *
 * @param a <Insert description of a>
 * @param b <Insert description of b>
 * @return <Insert description of the return value>
 */

私はネットを見回しましたが、答えに最も近いのはこの古いSOの質問です。この答えは、もはや維持されていないdoxymacsモードに依存しています。


c-sharp-modeはこれを行う何かがあると思います。
erikstokes 2015

新しい機能または既存の機能に対してこれを実行しますか?
itjeyd 2015

質問をするとき、関数のシグネチャから生成されるdoxygenコメントについて考えていました。
Rovanion、2015

回答:


4

私は標準のdoxymacsベースのマッシュアップと、答えとしてすでに述べたabo-aboのセマンティックベースのマッシュアップである次のものを使用します。これには、セマンティックとyasnippetのみが必要です。これにより、abo-aboのバージョンと比べて、yasnippetプレースホルダーのいくつかに関連情報が事前に入力されます。


# -*- mode: snippet -*-
# name: dox
# key: dox
# type: command
# --
(unless (and (fboundp 'semantic-current-tag)
             semantic-mode)
  (error "Semantic required to use dox snippet"))
(let ((tag (senator-next-tag)))
  (while (or (null tag)
             (not (semantic-tag-of-class-p tag 'function)))
    (setq tag (senator-next-tag)))
  (let* ((name (semantic-tag-name tag))
         (attrs (semantic-tag-attributes tag))
         (args (plist-get attrs :arguments))
         (return-name (plist-get attrs :type))
         (idx 1))
    (if (listp return-name)
      (setq return-name (car return-name)))
    (yas/expand-snippet
     (format
      "/**
* @brief ${1:%s}
*
%s
%s*/
"
      name
      (mapconcat
       (lambda (x)
         (format "* @param %s ${%d:Description of %s}"
                 (car x) (incf idx) (car x)))
       args
       "\n")
      (if (and return-name (not (string-equal "void" return-name)))
          (format " * @return ${%d:%s}\n" (incf idx) return-name)
        "")))))


このソリューションは完全に機能しますが、セマンティックモードが必要なすべてのコードを処理するまで待機する必要があり、少し面倒です。代わりに変数の前にdox <tab>を書くと、emacsが無限ループに陥ってしまいました。しかし、一つは、この世界のすべてのものを持つことはできません:D
Rovanion

moo-doxygenよりも豊富なので、これは上記より高く投票する必要があります
Alejandro Erickson

3

この機能をfunction-argsに追加しました。

興味があれば、ここにコードがあります。CEDETを使用しています:

(defun moo-doxygen ()
  "Generate a doxygen yasnippet and expand it with `aya-expand'.
The point should be on the top-level function name."
  (interactive)
  (move-beginning-of-line nil)
  (let ((tag (semantic-current-tag)))
    (unless (semantic-tag-of-class-p tag 'function)
      (error "Expected function, got %S" tag))
    (let* ((name (semantic-tag-name tag))
           (attrs (semantic-tag-attributes tag))
           (args (plist-get attrs :arguments))
           (ord 1))
      (setq aya-current
            (format
             "/**
* $1
*
%s
* @return $%d
*/
"
             (mapconcat
              (lambda (x)
                (format "* @param %s $%d"
                        (car x) (incf ord)))
              args
              "\n")
             (incf ord)))
      (aya-expand))))

auto-yasnippetも必要です。どちらのパッケージもMELPAで使用できます。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.