|
Documentation : Tags spécifiques au C++
|
|
@class
Le tag
@classest utilisé pour mettre de la documentation sur les objets. Il n'y a pas de sous-tags, mais vous pouvez (en fait, il est fortement recommendé) mettre de la documentation à l'intérieur de la déclaration de l'objet.
/*!
* @class XWing
* @abstract Un des meilleurs intercepteurs spaciaux.
* @discussion Le vaisseau mythique utilisé par les
* rebelles contre l'Empire.
*/
class XWing : public SpaceShip
{
public:
/*! @var r2d2 Robot mecanicien */
mechanicDroid *r2d2;
/*!
* @function go
* Envoie le vaisseau en mission.
* @param urgence Niveau d'urgence de la mission.
* @result Valeur booleenne qui indique le statut du
* resultat de la mission.
*/
bool go(int urgence);
private:
/* @var mission La mission en cours */
void *mission;
};
Page suivante : Récapitulation de tous les tags | ||
| Copyright © 2000-2001 | | | Informations sur la licence |