Documentation du code
Gardez votre code bien documenté grâce à la prise en charge du célèbre format Doxygen.
Prévisualisez la documentation
Consultez un aperçu de la documentation Doxygen dans la fenêtre contextuelle Quick Documentation (Ctrl+Q). Les commandes Doxygen sont analysées et alignées harmonieusement à cet endroit, avec les informations de type.
Si les paramètres d'une fonction sont documentés indépendamment de sa description, CLion fusionne tous les commentaires et affiche la documentation complète de la signature de la fonction (comme le fait Doxygen lors de la génération du résultat).
Renommez en toute sécurité
Pour garder la documentation correcte, utilisez la refactorisation Rename Maj+F6 pour mettre à jour le nom de la fonction ou ses paramètres. CLion actualise alors les commentaires Doxygen ainsi que les autres références.
Utilisez la saisie automatique
Pour accélérer la saisie, CLion intègre la saisie semi-automatique des commandes et des paramètres de fonction Doxygen.
Générez la documentation
Pour ajouter un nouveau commentaire Doxygen à une fonction, il suffit de le générer. Saisissez /**, /*!, /// or //! puis appuyez sur Entrée. Une ébauche est généré pour vous si votre fonction a des paramètres, renvoie une valeur ou lève une exception.
Documentation rapide
- Les détails de signature des fonctions.
- La documentation du code (commentaires standard ou Doxygen).
- Les types inférés, ce qui est particulièrement utile pour le C++ moderne qui ne comporte pas forcément de types explicites.
- Taille du type.
- Le remplacement des macros pour vous aider à mieux comprendre et déboguer les macros imbriquées.
- Les valeurs des expressions constantes.
- La valeur des
enumsous forme d'entiers.