Le javadoc aussi loin que je peux dire, le DOXYGEN Voir aussi strong> ? p> Cette question concerne comment faire un "voir aussi" dans le cadre d'un commentaire, par exemple: p> @See code> permet une simple chaîne comme argument de faire référence à quelque chose comme un livre, par exemple: \ Voir code> n'offre aucun équivalent. Y a-t-il un moyen d'avoir une référence de livre générée dans la documentation, par exemple: p>
Code> Le langage de programmation C ++ EM>, Bjarne Stroustrup, Addison-Wesley, 2000, Section 19.4.1: l'allocator standard em> p> p>
blockQuote> Clarification H1>
/**
* Allocates memory in an amazing way.
* \param size The number of bytes to allocate.
* \return Returns a pointer to the start of the allocated memory.
* \see MyOtherClass::alloc()
* \see "The C++ Programming Language," Bjarne Stroustrup, Addison-Wesley, 2000,
* section 19.4.1: The Standard Allocator.
*/
void* my_alloc( size_t size );
3 Réponses :
Si votre question concerne le style, vous pouvez définir votre propre étiquette avec Aliases option de configuration.
Si votre question concerne la création d'une page de bibliographie, vous pouvez définir une balise de référence croisée spécifique, en utilisant \ xrefitem tag.
Bien sûr, vous pouvez combiner les deux.
Si votre question concerne la gestion d'une base de données bibliographique, ALA Note ou Bibtex, j'ai peur que Doxygen n'est pas le meilleur outil.
Définir ma propre balise ne serait pas "Fusionner automatiquement" avec d'autres \ Voir Tags. Il ne s'agit pas de créer une page de bibliographie ni de la base de données.
De nos jours, on peut utiliser Bibtex pour donner des références.
J'ai essayé de multiples \ voir dans mon projet et Doxygen la fusionne en une seule section "Voir aussi": sortie est: utilisez-vous la dernière version de DOXYGEN?
MyotherClass :: ALLOC ()
"Le langage de programmation C ++," Bjarne Stroustrup, Addison-Wesley, 2000,
3
4
Je n'ai jamais prétendu que Doxygen ne fusionne pas de multiples \ Voir ensemble: j'ai dit que si je pouvais définir ma propre tag, il ne fusionnerait pas que avec \ See car ce serait ma propre tag et pas un \ voir. Votre exemple montre une manière non documentée à utiliser \ Voir avec une chaîne (votre deuxième ligne).
tandis que je suis un peu en retard à cela, j'espère que ce qui suit est utile.
Vous pouvez en effet utiliser une chaîne avec le \ Voir commande (qui est incluse pour la compatibilité avec Javadoc et est simplement un alias de \ SA ), comme Dmitriy l'a montré, même si cela est sans papiers.
Alternativement, et peut-être plus correctement, vous pouvez essayer d'utiliser le \ cite commande pour ajouter une référence bibliographique.
Enfin, vous indiquez que
Notez que s'il existe plusieurs tags \ Voir, ils doivent être fusionnés dans une section unique "Voir aussi" (comme le chemin \ Voir normalement fonctionne [)].
Doxygen fusionne plusieurs
\ voir S et\ SA 's ensemble comme Dmitriy démontre. Cependant, dans les commentaires de la réponse de Dmitriy, vous indiquez queJe n'ai jamais prétendu que Doxygen ne fusionne pas plusieurs \ voir ensemble: j'ai dit que si je pouvais définir ma propre tag, il ne fusionnerait pas cela avec
\ voir car ce serait ma propre balise et non un\ voir .Il est possible de définir votre propre balise et de la faire fusionner dans la section "Voir aussi" si votre balise est un alias sur
\ SA . .
Pourquoi l'exemple de la documentation ne fonctionne-t-il pas? Il devrait basé sur la réponse de Dimitriy. Peut-être que vous pouvez expliquer pourquoi dans la question.
De nos jours, on peut utiliser Bibtex pour donner des références