Où puis-je trouver la documentation pour les commentaires de la documentation QT? Je fais référence à la manière dont qt utilise un style spécifique pour les commentaires de la documentation, comme: ... Vous obtenez la photo. Alors, où puis-je trouver des informations sur tous les interrupteurs, comme \ Classe, \ Listez-vous, \ Bref, etc., quel) outil (s) dois-je utiliser pour générer des fichiers de documentation à partir de ces commentaires dans mes fichiers source? DOXYGEN prend-il en charge cette syntaxe?
4 Réponses :
Vous pouvez regarder le code source QT lui-même pour les commentaires de la documentation QT ...
J'ai utilisé Doxygen pour la documentation et pour moi, cela fonctionne bien, bien que les normes de documentation ne soient pas de qt. Je vous suggère de tenter et de décider.
N'utilisez pas QDoc. Il est obsolète . Utilisez Doxygen, qui est basé sur QDOC de toute façon.
Cela dit, la documentation (au format QDoc :-d) est
Je cherchais qt.gitorious.org/qt/pages/docmanual et qt.gitorious.org/qt/pages/docmarkupcommands . Sans savoir ce qu'il a été appelé (qdoc, hein?) Je ne pouvais pas le faire Google. Beaucoup de liens semblent être morts cependant
Maintenant, dis-tu que le QDoc outil est obsolète, ou la syntaxe QDoc la syntaxe (y compris l'outil) est obsolète? Nokia utilise la syntaxe QDoc exclusivement à Qt, est-ce que juste pour la compatibilité à l'envers ou si un style différent (comme Javadoc Commentaires) sera utilisé à la place? Évidemment, il appartient à un programmeur mais je tiens à rester compatible avec le reste de QT ou quoi que ce soit, Nokia recommande.
Merci pour les informations, cela m'a épargné beaucoup de temps. J'allais pour QDoc3 ... imbécile!
Êtes-vous sûr que la documentation QT est (toujours) obsolète? Le lien que vous fournissez est mort, et il y a un QDoc Documentation dans la version QT actuelle .
La réponse adresse QT <= 4.8, puisque Qt 5 a été publiée en 2012. Les liens indiquent désormais le contenu de l'intendant. Pour ce qui concerne Qt 5.x, QDoc3 a été renommé à QDoc. Longue histoire courte, il peut utiliser être utilisé pour la documentation mais car il est développé pour répondre aux besoins de la documentation QT, il peut changer de manière incompatible d'une version à une autre et pourrait être nécessaire pour Faites du travail pour le maintenir en cours d'exécution. L'histoire plus longue peut être lue ici .
Utilisez Doxygen pour créer une documentation
Il peut générer un navigateur de documentation en ligne (en HTML) et / ou un manuel de référence hors ligne (latex) à partir d'un ensemble de fichiers source documenté. Il existe également une prise en charge de la production de sortie dans RTF (MS-Word), PostScript, PDF hyperliété, HTML compressé et UNIX Man. La documentation est extraite directement des sources, ce qui facilite la maintien de la documentation compatible avec le code source.
Vous pouvez configurer DOXYGEN pour extraire la structure de code à partir de fichiers source non documenté. Ceci est très utile pour trouver rapidement votre chemin dans les distributions de grandes sources. Vous pouvez également visualiser les relations entre les différents éléments au moyen d'inclure des graphiques de dépendance, des diagrammes d'héritage et des diagrammes de collaboration, qui sont tous générés automatiquement.
Il y a deux parties de Doxygen qui sont spécifiques qt-spécifiques : le style qt style et la balise de configuration de qt_autoBrief DOXYFILE. Ce sont simplement des parties de doxygène utilisées par qt. Tous les commentaires Doxygen utilisés par QT sont des trucs doxygen réguliers. Donc, vous avez juste besoin de lire Doxygen.
ou peut-être êtes-vous vraiment à la recherche de documentation d'internes QT, telles que des informations sur les pointeurs D contenus dans Cette entrée de blog
Style QT Commentaires:
Le Cadre Qt_AutoBrief:
Si la balise "qt_autobrief" est définie sur true dans le fichier DOXYFILE, la première ligne d'un bloc de commentaire de style Qt est automatiquement interprétée comme la brève description.
de l'aide de l'interface graphique DOYGEN:
la balise qt_autobriet est définie sur oui
puis Doxygen interprétera le premier
ligne (jusqu'au premier point) d'un
Commentaire de style qt comme bref
la description. Si réglé sur Non, le
Les commentaires vont se comporter comme régulier
Commentaires de type qt (nécessitant ainsi un
Commande Explicit \ Bref pour un bref
Description.)
/ *! Texte * / Le style de commentaire s'appelle le "style qt" des commentaires DOXYGEN. Le ! marque l'intégralité du bloc de commentaire en tant que bloc de commentaire DoxyGen. C'est une partie standard et optionnelle de Doxygen.