Changer le style de commentaire doxygen dans Eclipse
en d'autres termes tapez /** et appuyez sur entrée sur une ligne avant un moment, me donne quelque chose comme:
/**
*
* @param one
* @param two
* @return
*/
Foo(int one, int two);
et je veux qu'il me donner quelque chose comme:
/**********************************************************************/
///
/// param one
/// param two
/// return
/***********************************************************************/
Foo(int one, int two);
aussi, plus un si quelqu'un sait comment lier ceci à un raccourci clavier (comme alt -maj - j pour éclipse JDT).
aussi, pour info, le fait que Eclipse CDT supporte maintenant Doxygen semble être un fait peu connu basé sur Google. Voir ici pour plus de détails. Doxygen peut être activé sous les propriétés du projet en sélectionnant "Activer les paramètres spécifiques au projet" dans l'onglet "C/C++ général" et en sélectionnant "Doxygen". Ma version CDT est 7.0.1, mais je pense que c'est devenu disponible en 5.0.
enfin, la section commentaires sous modèles de code dans Préférences n'accomplit pas cela basé sur mes tests.
EDIT: Voir ici. On dirait que le style de commentaire est codé. Si quelqu'un trouve le contraire, j'aimerais le savoir. Je suppose que les gabarits seront la meilleure chose pour l'instant à moins que le style Javadoc ne vous convienne.
4 réponses
Oui, cela semble être un bug dans Eclipse CDT.
comme solution de contournement, je vous suggère de créer un modèle personnalisé auquel vous pouvez accéder avec le Ctrl+Espace combinaison de touches.
Dans Eclipse Helios: Fenêtre -> Préférences -> C/C++ -> Editeur -> Modèles
Cliquez sur Nouveau... pour créer un nouveau modèle et dans le Nom champ Utiliser un nom descriptif, p. ex. "commentaire-fonction", et ajouter votre commentaire doxygen dans le champ. Confirmer et appliquer ce changement.
dans votre code vous pouvez alors aller à la ligne au-dessus de votre déclaration de fonction, tapez les premières lettres de votre nom de modèle personnalisé Suivi du Ctrl+Espace combinaison de touches.
Dans cet exemple:
com<Ctrl+space>
affichera la boîte de dialogue Content Assist filtrée avec" com* "à partir de laquelle vous pouvez sélectionner la fonction "comment-function"" modèle.
Remarque:
com<Ctrl+space+space>
filtrera encore plus en montrant seulement les propositions de modèles dans la fenêtre pop-up D'aide de contenu.
c'est une configuration que j'ai trouvée dans mon commentaire java
et quand j'ai édité comme montré mon commentaire java doc changé en
essayez de rechercher une configuration similaire sous votre configuration php.
je peux obtenir de la manière de ce que vous voulez en allant à: Préférences - PHP - Code de Style - les Modèles de Code - Commentaires.
Je ne suis pas sûr que cela vous permettra d'utiliser des antislashs au lieu de @s pour vos mots-clés, mais je pense qu'il devrait atteindre la plupart de ce que vous voulez.
une balise Doxygen utilise ce format de base.
/**
Your tags and such. It MUST have the /** and the */.
*/
il doit absolument avoir le / * * * / autour de l'ensemble du commentaire de Doxygen. Si vous modifiez les gabarits de Code il fera ce que vous voulez.
Le projet de commentaires du style est mal.
/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn't actually a Doxygen block and shouldn't work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.
ce qui suit est la norme pour la plupart des entreprises qui codent en JAVA et eclipse. Comme Doxygen est valide pour plusieurs langues, c'est aussi valable pour C/C++.
/**
* Brief description.
*
* @param[in|out] <value> <description>
*/
si vous voulez utiliser le style xml balise...
/// <summary>
/// This is a summary of the class, blah, blah.
/// </summary>
vous allez aussi vouloir vous assurer qu'eclipse n'insère pas d'autres styles de commentaires, sinon vous pouvez vous retrouver avec des commentaires insérés dans d'autres commentaires. Aussi, généralement, c'est une mauvaise règle de mélange commentaire styles comme /** */ et ///.
enfin si vous sélectionnez auto-generate comments lorsque vous créez des classes et ces commentaires seront automatiquement mis en. Et vous pouvez avoir des en-têtes de méthode auto-generate d'eclipse comme vous tapez (bien que j'oublie comment je a cette).