¿Alguien sabe si hay un archivo XSD en alguna parte que se puede utilizar para validar la documentación XML que se genera cuando se compila un proyecto de C# con la opción/doc?XSD para documentación XML generada para C#?
que desea modificar ese archivo manualmente después de que se ha generado y estoy buscando una manera fácil de confirmar que no he dañado la estructura del archivo.
Gracias.
Me encontré con esta vieja pregunta hoy ... No vi esto al mirar la documentación de Microsoft, ni cuando busqué otros proyectos que pensé que podrían tener interés en desarrollar dicho esquema; a saber, las fuentes para el Sandcastle y (a largo difunto) Las NDoc proyectos.
corto de retroceder para tratar de definir un esquema por su cuenta, una cosa que podría sugerir sería utilizar una de las muchas herramientas que van a generar un XSD a partir de XML. Microsoft incluye XSD.EXE como parte de Visual Studio y sus SDK.
Puede escribir una fuente ficticia que ejercite cada una de las etiquetas de comentario de la documentación XML, compilar el archivo de documentación XML para ella y luego usar XSD.EXE. para generar un XSD a partir de eso, y usarlo para validar el documento XML después de que se termine su procesamiento. Pero creo que podría resultar menos trivial de lo que parece.
Además, comentarios de la documentación XML se refieren a los tipos y elementos de código, y hay muchas cosas que un esquema no se pondrá al día; por ejemplo, la verificación de que el atributo de nombre de una etiqueta <param> todavía se refiere a un nombre de parámetro real en su C# fuente. El compilador verifica tales elementos en tiempo de compilación. Pero si procesa posteriormente la documentación XML, necesitaría una herramienta personalizada que tuviera una referencia a la fuente original de C# o los conjuntos generados para volver a verificar tales referencias.
finalmente se rompió y escribió uno: XSD for Xml Comments for .NET Documentation
Sé que esta es una respuesta anterior, pero estoy tratando de encontrar documentación sobre el formato del atributo de nombre del elemento miembro. Veo la expresión regular, pero estoy buscando documentación sobre cómo interpretar eso. – Jeremy
No contesta estrictamente su pregunta, pero aquí es [una lista de etiquetas recomendado] (http://msdn.microsoft.com/en-us/library/5ast78ax. aspx) con enlaces a ejemplos de uso. NOTA: puede seleccionar versiones de Visual Studio aplicables en la página. – Steven