6
votes

DOXYGEN-Style Commentaires dans Vim pour C ++

J'aimerais automatiser l'insertion des extraits de commentaire pour les fichiers C ++. Recherche Google Suggestion C.VIM Plugin. Je l'ai installé. Maintenant, lorsque je crée un fichier, je reçois un modèle comme suit. XXX

de : H Csupport Je sais que je peux créer mes propres modèles pour commentaires. Y a-t-il un moyen plus simple d'obtenir des commentaires de style Doxygen dans le projet? Ou peut-être que ces modèles sont disponibles quelque part?


0 commentaires

3 Réponses :


8
votes

Si vous n'avez besoin que de ces commentaires et non les autres fonctionnalités de C.Vim, je vous recommanderais d'utiliser un plug-in des extraits, tels que Snipmate ou ultisnips . La création de tels extraits avec ces plugins est très facile et ils sont très puissants.


0 commentaires

1
votes

LH-CPP & MU-Modèle est livré avec des en-têtes de projet syntonisables (la valeur par défaut est assez mauvaise que je dois admettre). Vous devrez remplacer les modèles / C / internes / C-File-Header.Template à quelque chose comme: XXX PRE>

(toutes les autres choses sont déjà prises en charge: Les gardes seront ajoutés automatiquement dans les fichiers d'en-tête, et foo.h sera automatiquement inclus dans FOO.c (pp)) p>

puis dans un Plugin LOCAL_VIMRC , vous devrez définir: P>

/**
 * «brief explanation».
 * «details»
 * @param[«in,»out] list  «list-explanations»
 * @param[in] size  «size-explanations»
 * @param[in] key  «key-explanations»
 * @param[«in,»out] rec  «rec-explanations»
 *
 * @return «bool»
 * «@throw »
 * @pre <tt>list != NULL</tt>«»
 */
bool jw_search ( int* list, int size, int key, int& rec )


0 commentaires

5
votes

Vous pouvez utiliser Doxygen Plugin pour Vim. Il est disponible ici . Entrez simplement: DOX pour ajouter vos commentaires.

Par exemple, P>

/**
 * @brief 
 *  
 * @param list 
 * @param size
 * @param key
 * @param rec
 *
 * @return 
 */
bool jw_search ( int *list, int size, int key, int& rec )
{
    return true;
}


0 commentaires