2010-07-06 11 views
6

Est-ce que quelqu'un sait s'il existe un fichier XSD quelque part qui peut être utilisé pour valider la documentation XML générée lorsque vous compilez un projet C# avec l'option/doc?XSD pour la documentation XML générée pour C#?

Je veux modifier ce fichier manuellement après qu'il a été généré et je cherche un moyen facile de confirmer que je n'ai pas endommagé la structure du fichier.

Merci.

+0

ne serait pas strictement répondre à votre question, mais voici [une liste d'étiquette recommandée] (http://msdn.microsoft.com/en-us/library/5ast78ax. aspx) avec des liens vers des exemples d'utilisation. REMARQUE: vous pouvez sélectionner les versions Visual Studio applicables sur la page. – Steven

Répondre

2

Je suis tombé sur cette vieille question aujourd'hui .. Je n'ai pas vu cela en regardant la documentation de Microsoft, ni en regardant d'autres projets que je pensais avoir un intérêt à développer un tel schéma; à savoir, les sources pour les projets Sandcastle et (long-défunt) NDoc. À moins de revenir en arrière pour essayer de définir un schéma par vous-même, une chose que je pourrais suggérer serait d'utiliser l'un des nombreux outils qui généreront un XSD à partir de XML. Microsoft inclut XSD.EXE dans le cadre de Visual Studio et de ses SDK.

Vous pouvez écrire une source factice qui exécute chacune des balises de commentaire de la documentation XML, générer le fichier de documentation XML correspondant, puis utiliser XSD.EXE. pour générer un XSD à partir de cela, et l'utiliser pour valider le document XML après que votre traitement est terminé. Mais je pense que cela pourrait s'avérer moins trivial que cela puisse paraître. De plus, les commentaires de documentation XML se réfèrent aux types et aux éléments de code, et il y a beaucoup de choses qu'un schéma n'attrape pas; par exemple, en vérifiant que l'attribut name d'une balise <param> fait toujours référence à un nom de paramètre réel dans votre source C#. Le compilateur vérifie ces éléments au moment de la construction. Mais si vous post-traitementz la documentation XML, vous aurez besoin d'un outil personnalisé qui fait référence à la source C# d'origine ou aux assemblages générés pour revérifier ces références.

8

je me suis finalement tombé en panne et a écrit un: XSD for Xml Comments for .NET Documentation

+0

Je sais que c'est une vieille réponse, mais j'essaie de trouver de la documentation sur le format de l'attribut de nom d'élément membre. Je vois la regex, mais je cherche de la documentation sur la façon d'interpréter cela. – Jeremy