Qualcuno sa se c'è un file XSD da qualche parte che può essere utilizzato per convalidare la documentazione XML che viene generata quando si compila un progetto C# con l'opzione/doc?XSD per la documentazione XML generata per C#?
Voglio modificare manualmente quel file dopo che è stato generato e sto cercando un modo semplice per confermare che non ho danneggiato la struttura del file.
Grazie.
Oggi sono incappato in questa vecchia domanda .. Non l'ho visto guardando la documentazione di Microsoft, né guardando altri progetti che pensavo potessero interessare allo sviluppo di tale schema; vale a dire, le fonti per i progetti Sandcastle e (a lungo defunto) NDoc.
In mancanza di un passo indietro per provare a definire uno schema per conto proprio, una cosa che potrei suggerire sarebbe quella di utilizzare uno dei tanti strumenti che generano un XSD da XML. Microsoft include XSD.EXE come parte di Visual Studio e dei relativi SDK.
È possibile scrivere una sorgente fittizia che esercita ciascuno dei tag di commento della documentazione XML, creare il file di documentazione XML per esso, quindi utilizzare XSD.EXE. per generare un XSD e utilizzarlo per convalidare il documento XML al termine dell'elaborazione. Ma penso che potrebbe rivelarsi meno banale di quanto sembri.
Inoltre, i commenti di documentazione XML si riferiscono a tipi ed elementi di codice e ci sono molte cose che uno schema non catturerà; ad esempio, verificando che l'attributo nome di un tag <param> si riferisca ancora a un nome di parametro effettivo nell'origine C#. Il compilatore verifica tali elementi al momento della compilazione. Tuttavia, se si post-processa la documentazione XML, è necessario uno strumento personalizzato che abbia un riferimento all'origine C# originale o agli assembly generati per verificare nuovamente tali riferimenti.
ho finalmente rotto e ha scritto uno: XSD for Xml Comments for .NET Documentation
So che questa è una vecchia risposta, ma sto cercando di trovare la documentazione sul formato dell'attributo del nome dell'elemento membro. Vedo la regex, ma sto cercando la documentazione su come interpretarlo. – Jeremy
Non ritiene strettamente risponde alla tua domanda, ma qui è [un elenco tag consigliato] (http://msdn.microsoft.com/en-us/library/5ast78ax. aspx) con collegamenti ad esempi di utilizzo. NOTA: è possibile selezionare le versioni di Visual Studio applicabili nella pagina. – Steven