none
Documenter ses objets RRS feed

  • Question

  • Bonjour, 

    est il possible de documenter ses objets pour qu'au moment de taper du code
    l'EDI de visual studio affiche un texte d'explication en plus du nom et des arguments sur une de nos propres fonctions ?

    Merci

    mardi 21 avril 2015 15:34

Réponses

  • Bonsoir,
    En C# c'est possible!
    Devant chaque déclaration, classe, fonction, propriété, vous tapez trois / et visual studio complète en insérant des balise XML. Ce que j'ai ajouté est entre crochets.
    Par exemple
    ///<SUMMARY>
    ///[Convertit les coordonnées dessin en coordonnées écran]
    ///<param name="p_MX"></param>
    ///<param name="p_LstPt"></param>
    ///<returns>[coordonnées écran]</return>

    static public List<PointF> getPointAffichage(GMatrice p_MX, List<PointF> p_LstPtDessin)
    {
    ...
    }
    Lorsque vous tapez votre code Visual studio affiche la déclaration de la fonction et le contenu des balises XML comme ci dessous:
    Cordialement
    Gérard
    Apparemment les images s'affichent mal.
    Désolé!

     



    mardi 21 avril 2015 20:12

Toutes les réponses

  • Bonsoir,
    En C# c'est possible!
    Devant chaque déclaration, classe, fonction, propriété, vous tapez trois / et visual studio complète en insérant des balise XML. Ce que j'ai ajouté est entre crochets.
    Par exemple
    ///<SUMMARY>
    ///[Convertit les coordonnées dessin en coordonnées écran]
    ///<param name="p_MX"></param>
    ///<param name="p_LstPt"></param>
    ///<returns>[coordonnées écran]</return>

    static public List<PointF> getPointAffichage(GMatrice p_MX, List<PointF> p_LstPtDessin)
    {
    ...
    }
    Lorsque vous tapez votre code Visual studio affiche la déclaration de la fonction et le contenu des balises XML comme ci dessous:
    Cordialement
    Gérard
    Apparemment les images s'affichent mal.
    Désolé!

     



    mardi 21 avril 2015 20:12
  • Bonjour FredJust,

    Pouvons-nous considérer que vous avez résolu votre problème avec le scénario proposé?

    Voici le code converti en VB:

    Public Shared Function getPointAffichage(p_MX As GMatrice, p_LstPtDessin As List(Of PointF)) As List(Of PointF)
    End Function
    

    Désormais, nous marquons la solutions proposée. N'hésitez pas à revenir et supprimer la réponse marquée si la solution n’est pas correcte. Merci d'avance!

    Cordialement,
    Nina


    Microsoft propose ce service gratuitement, dans le but d'aider les utilisateurs et d'élargir les connaissances générales liées aux produits et technologies Microsoft. Ce contenu est fourni "tel quel" et il n'implique aucune responsabilité de la part de Microsoft.

    jeudi 30 avril 2015 13:37
    Modérateur