Önceden doldurulmuş bir oksijen yorumu üreten bir yasnippet var mı?

10

Aşağıdaki C ++ işlevi için:

bool importantStuff(double a, double b);

Belki de etiketleri olmadan aşağıdaki snippet'i çıkarmalıdır:

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

Ben net etrafına baktım, ama bir cevaba en yakın ben cevap artık tutulan doxymacs moduna bağlıdır bu eski SO soru.

yasnippet c++

— Rovanion
kaynak

Bence c-sharp-modebunu yapan bir şey var.

— erikstokes

Bunu yeni işlevler veya mevcut işlevler için yapmak istiyor musunuz?

— itsjeyd

Soruyu sorarken, fonksiyonun imzasından üretilen doxygen yorumunu düşünüyordum.

— Rovanion

4

Şimdiden bir cevap olarak belirtilen standart doksisik tabanlı ve abo-abo semantik tabanlı bir karışım olan aşağıdakileri kullanıyorum - bu sadece semantik ve yasnippet gerektirir. Bu, yasnippet yer tutucularının bir kısmını, abo-abo'nin versiyonuna göre de ilgili bilgilerle dolduruyor.


# -*- 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)
        "")))))

— alexmurray
kaynak

Bu çözüm kesinlikle işe yarıyor, ancak semantik modun gerekli tüm kodu çalması için beklemek zorunda kalmak biraz hantal. Ben de değişken yerine önce dox <tab> yazarsanız emacs sonsuz döngülerde sıkışıp kaldım. Ama bu dünyada her şeye sahip olamaz: D

— Rovanion

moo-doxygen'ten daha zengin olduğu için bu, yukarıdakilerden daha yüksek seçilmelidir

— Alejandro Erickson

3

Bu özelliği işlev argümanlarına ekledim .

İlgileniyorsanız kod İşte. CEDET kullanıyor:

(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))))

Ayrıca otomatik yasnippet'e de ihtiyacınız var . Her iki paket de MELPA'da mevcuttur.

— Abo-Abo
kaynak