IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Framework .NET Discussion :

Documentation et exceptions


Sujet :

Framework .NET

  1. #1
    Membre averti
    Profil pro
    Inscrit en
    Février 2003
    Messages
    837
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Meurthe et Moselle (Lorraine)

    Informations forums :
    Inscription : Février 2003
    Messages : 837
    Points : 377
    Points
    377
    Par défaut Documentation et exceptions
    Bonjour à tous,

    Sur une très grosse application, avec un coeur de métier très vaste et très labyrinthique, je chercher à créer une documentation carrée et nickelle.
    Sur le principe, c'est assez simple à faire sauf pour une chose :

    Imaginons :
    Une fonction A qui appelle
    Une fonction B qui appelle
    Une fonction C
    Une fonction B2

    Imaginons maintenant que la fonction C lève une exception spécifique.
    Si je documente la fonction C, j'ajoute la balise déclarative pour exception et je lui met une description.
    Par contre, lorsque je vais géréner la documentation globale, la fonction A ne stipulera pas qu'elle peut lever une exception spécifique (par bubbling de la fonction C vers la fonction A).

    On pourrait très bien dire : bah documentes chaque fonction qui appelle la fonction C et fait de même pour les fonctions qui appellent les fonctions qui appellent fonction C et ainsi de suite.
    Le problème c'est qu'à maintenir c'est la zone complet ! Là l'exemple est simple avec 3 niveaux d'appels mais dans certains cas on part dans les tréfonds de l'appli avec je ne sais combien de niveaux et dans le dernier niveau il y a une exception spécifique qui peut être lancée.
    Si je modifie cette fonction, il faut que je recherche tous les appelants, que je les documente, puis que je fasse de meme avec les appelants des appelants et ainsi de suite.

    Bref, quelle serait la meilleure solution pour pouvoir documenter de façon la plus complète les fonctions "point d'entrée" pour prendre en compte toutes les exceptions qui pourraient potentiellement être levées par les sous fonctions (en tout cas, exceptions qu'on leve explicitement dans l'appli, pas les autres) ?

  2. #2
    Membre émérite Avatar de meziantou
    Homme Profil pro
    Ingénieur R&D
    Inscrit en
    Avril 2010
    Messages
    1 223
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 33
    Localisation : Canada

    Informations professionnelles :
    Activité : Ingénieur R&D
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2010
    Messages : 1 223
    Points : 2 439
    Points
    2 439
    Par défaut
    Je vois 2 possibilités:
    - Utiliser le plugin Exceptional de Resharper : http://exceptionalplugin.codeplex.com/
    - Parser ton appli post compilation et construire l'arbre des appels. Tu peux ensuite modifier le fichier XML de documentation pour inclure les exceptions lancées par une méthode dans les méthodes appelantes (faire attention au fait que l'exception peut être catchée)
    http://stackoverflow.com/questions/9...a-given-method

  3. #3
    Rédacteur/Modérateur


    Homme Profil pro
    Développeur .NET
    Inscrit en
    Février 2004
    Messages
    19 875
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 42
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Février 2004
    Messages : 19 875
    Points : 39 749
    Points
    39 749
    Par défaut
    Citation Envoyé par meziantou Voir le message
    Je vois 2 possibilités:
    - Utiliser le plugin Exceptional de Resharper : http://exceptionalplugin.codeplex.com/
    Sympa ce truc, je connaissais pas... je l'installe tout de suite

    EDIT: bah en fait non, c'est pas compatible avec R# 8

  4. #4
    Membre émérite Avatar de meziantou
    Homme Profil pro
    Ingénieur R&D
    Inscrit en
    Avril 2010
    Messages
    1 223
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 33
    Localisation : Canada

    Informations professionnelles :
    Activité : Ingénieur R&D
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2010
    Messages : 1 223
    Points : 2 439
    Points
    2 439
    Par défaut
    Il semblerait qu'un fork pour R#8 existe (je n'ai pas testé)
    http://exceptionalplugin.codeplex.co...er8Integration

  5. #5
    Membre averti
    Profil pro
    Inscrit en
    Février 2003
    Messages
    837
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Meurthe et Moselle (Lorraine)

    Informations forums :
    Inscription : Février 2003
    Messages : 837
    Points : 377
    Points
    377
    Par défaut
    Salut,

    Merci pour cette info. Je suis en train d'essayer d'utiliser le plugin mais après l'avoir installé, je ne le trouve pas dans visual studio :/ surement à cause du fait que je sois en V8.02

  6. #6
    Membre averti
    Profil pro
    Inscrit en
    Février 2003
    Messages
    837
    Détails du profil
    Informations personnelles :
    Âge : 41
    Localisation : France, Meurthe et Moselle (Lorraine)

    Informations forums :
    Inscription : Février 2003
    Messages : 837
    Points : 377
    Points
    377
    Par défaut
    Quelqu'un aurait-il la version compilée de la dll pour resharper 8 ? parce que j'arrive pas à le compiler :/

  7. #7
    Rédacteur/Modérateur


    Homme Profil pro
    Développeur .NET
    Inscrit en
    Février 2004
    Messages
    19 875
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 42
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Février 2004
    Messages : 19 875
    Points : 39 749
    Points
    39 749
    Par défaut
    Citation Envoyé par zax-tfh Voir le message
    Quelqu'un aurait-il la version compilée de la dll pour resharper 8 ? parce que j'arrive pas à le compiler :/
    Il fallait juste refaire les références aux assemblies Resharper pour les faire pointer vers leur vrai emplacement

    Par contre j'ai pas compris comment ça s'utilise... Je l'ai mis dans mon répertoire Plugins, mais ça n'a pas l'air de donner grand chose
    Fichiers attachés Fichiers attachés

  8. #8
    Rédacteur/Modérateur


    Homme Profil pro
    Développeur .NET
    Inscrit en
    Février 2004
    Messages
    19 875
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 42
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Février 2004
    Messages : 19 875
    Points : 39 749
    Points
    39 749
    Par défaut
    Citation Envoyé par tomlev Voir le message
    Il fallait juste refaire les références aux assemblies Resharper pour les faire pointer vers leur vrai emplacement

    Par contre j'ai pas compris comment ça s'utilise... Je l'ai mis dans mon répertoire Plugins, mais ça n'a pas l'air de donner grand chose
    Ah si en fait ça marche ; apparemment il n'y a pas d'UI, c'est juste des inspections supplémentaires.

Discussions similaires

  1. Erreur "java.lang.AssertionError: Unexpected exception parsing XML document..."
    Par ZeRo0Cold dans le forum Persistance des données
    Réponses: 6
    Dernier message: 25/05/2015, 18h48
  2. Exception document xml
    Par jeeland dans le forum Développement Web en Java
    Réponses: 1
    Dernier message: 25/10/2013, 13h54
  3. Réponses: 4
    Dernier message: 12/12/2012, 13h16
  4. Réponses: 2
    Dernier message: 25/07/2012, 17h38
  5. Documentation gratuite sur l'API Windows, COM, DCOM, OLE, etc.
    Par Community Management dans le forum Windows
    Réponses: 1
    Dernier message: 16/11/2006, 16h28

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo