Je veux être capable de décorer des classes et des méthodes avec le texte qu'intellisense affiche lorsque vous instanciez la classe ou accédiez à un champ.Dans .Net, comment décorer une classe avec un pourboire intellisense?
Par exemple, je souhaite donner des instructions d'utilisation.
Je ne trouve pas la décoration appropriée pour cela. Comment fait-on ça?
ajouter ceci en haut de votre définition de classe ...
/// <summary>
/// Returns a pointless string
/// </summary>
/// <param name="name">Parameter to personalise the rubbish returned</param>
/// <returns>Utter junk is returned</returns>
Où résumé est ce qui est montré pour la description de classe, un noeud PARAM pour chaque élément qui décrit chaque paramètre et retour déclaration décrivant ce qui est revenu.
De plus, si vous tapez simplement '///' sur la ligne au-dessus de la propriété/méthode/variable, cela ajoutera toutes les balises XML nécessaires. – Bevin
Encore une question. Si vous dites "StringBuilder sb = new" il est dit "Représente ..." - quel est l'attribut de ce texte? – IamIC
@TomTom vous est-il déjà venu à l'esprit que la taille de la documentation est de gigaoctets et que vous devez connaître la terminologie correcte pour pouvoir la rechercher? Pensez-vous que j'aurais posté la question avant de regarder? Pourquoi pensez-vous que nous avons des tutoriels et des sites de support comme celui-ci? – IamIC
Je pense que cela peut être fait en utilisant le modèle Componenet
J'ai trouvé la réponse. Ajoutez simplement le commentaire /// au début de la définition de la classe (par opposition au constructeur et al). – IamIC
également en C# si vous écrivez /// dans la ligne juste au-dessus de la fonction, il insère automatiquement ce balisage au-dessus de la fonction. il inclut automatiquement les paramètres et les balises de type retour (le cas échéant) –