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

Dotnet Discussion :

Documentation XML - Comment ignorer des classes/namespaces/propriétés ou méthodes.


Sujet :

Dotnet

  1. #1
    Membre régulier
    Inscrit en
    Novembre 2006
    Messages
    131
    Détails du profil
    Informations personnelles :
    Âge : 40

    Informations forums :
    Inscription : Novembre 2006
    Messages : 131
    Points : 83
    Points
    83
    Par défaut Documentation XML - Comment ignorer des classes/namespaces/propriétés ou méthodes.
    Bonjour,

    J'utilise présentement Visual Studio 2010.
    Afin de réaliser la documentation, j'utilise les commentaires pour générer le fichier de documentation XML dans mes projets. Ensuite avec SandCastle je génère mon CHM...

    La question que je me pose aujourd'hui est : comment ignorer certains éléments (propriété, méthode, classe ou même un namespace complet) dans la documentation?
    Existe-t-il des attributs pouvant empêcher l'inclusion des éléments non désiré dans le fichier de documentation XML généré par Visual Studio?

    Merci,

    Johann

  2. #2
    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
    Je comprends pas trop ta question... si tu n'écris pas de commentaires de doc pour un type ou un membre, il n'apparaitra pas dans le fichier.

  3. #3
    Membre régulier
    Inscrit en
    Novembre 2006
    Messages
    131
    Détails du profil
    Informations personnelles :
    Âge : 40

    Informations forums :
    Inscription : Novembre 2006
    Messages : 131
    Points : 83
    Points
    83
    Par défaut
    Le fait est qu'il y a des commentaires mais auto générés par un outil tiers.
    Nous ne souhaitons pas documenter cette partie du projet auto générée.
    Malheureusement cette partie indésirable dans la documentation se trouve dans la même assembly que le code que l'on souhaite documenter... Mais sous un namespace différent.
    Je fini par penser que c'est avec SandCastle qu'on doit pouvoir faire ce tri. Mais comment...

  4. #4
    Membre régulier
    Inscrit en
    Novembre 2006
    Messages
    131
    Détails du profil
    Informations personnelles :
    Âge : 40

    Informations forums :
    Inscription : Novembre 2006
    Messages : 131
    Points : 83
    Points
    83
    Par défaut
    Effectivement, c'est ce que je pensais.
    Dans SandCastel il faut retirer les namespaces non désirés dans "Visibility/APiFilter".

+ Répondre à la discussion
Cette discussion est résolue.

Discussions similaires

  1. Réponses: 1
    Dernier message: 01/08/2012, 08h48
  2. Réponses: 2
    Dernier message: 01/02/2006, 15h02
  3. comment utilisé des classes toute prêtes
    Par Burinho dans le forum Langage
    Réponses: 3
    Dernier message: 23/01/2006, 22h18
  4. [Requete] Comment ignorer des lignes avec un LOAD DATA
    Par frangin2003 dans le forum Langage SQL
    Réponses: 2
    Dernier message: 09/11/2005, 12h14
  5. [debutant] Comment ajouter des .class ?
    Par Slein dans le forum Eclipse Java
    Réponses: 3
    Dernier message: 30/04/2004, 14h30

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