2011-03-14 23 views
19

De Java y Eclipse Estoy acostumbrado a @inheritDoc que permite utilizar la misma documentación que en la clase/método base.¿Heredar documentación en C#?

¿Cómo puedo lograr algo similar en C# y Visual Studio 2010?

+0

Ver http://stackoverflow.com/questions/311363/net-xml-docs-inheriting-documentation –

+0

Vote por https://visualstudio.uservoice.com/forums/121579-visual-studio/suggestions/3745102- add-intellisense-support-for-the-inheritdoc-ta –

Respuesta

11

No existe en vainilla VS. Su mejor apuesta es ghostdoc o similar. Esto está disponible en Extension Manager, o here

+0

Tal vez una actualización de esto -> la nueva herramienta de documentación de Microsoft 'Docfx' puede manejar esto – Schwarzie2478

1

Resharper proporciona accesos directos para copiar la documentación XML de las clases base.

+2

Más información sobre los atajos de ReSharper y preguntas relacionadas: http: // stackoverflow. com/questions/6042597/can-i-propagate-documentation-from-interface-to-it-implementation –

1

Mi complemento, AtomineerUtils duplicará la documentación de las sustituciones de la clase base y los métodos/propiedades de interfaz, de las sobrecargas en la misma clase y para los parámetros, también buscará parámetros con el mismo nombre utilizados en otra parte de la misma clase.

También puede ser capaz de utilizar los comandos XML de extensión como <inheritdoc> o <incluyen> si desea duplicar el texto de la documentación externa (Castillo de arena, Doxygen, etc), pero no estoy al tanto de ninguna manera de "dinámicamente" heredar la documentación para su uso "interno" (intelisense etc)

3

ReSharper no sólo proporciona teclas de acceso directo para copiar los comentarios base de clase, pero en realidad incluye <inheritdoc> comentarios en su intelisense encargo del modo que desee. Esto solo funciona si todo tu equipo está usando ReSharper, por supuesto. El uso de <inheritdoc> se explica así here

5

Incluso esta pregunta es un par de años y era específicamente para Visual Studio 2010. Para todos aquellos que la tierra aquí por Google, me gustaría añadir una respuesta que he encontrado y que es válido para Visual Studio 2015 en combinación con castillos de arena Constructor archivo de ayuda (SHFB):

/// <inheritdoc/> 

puede usarse para heredar los documentos de una clase base o una interfaz.

Aquí un enlace a la Ayuda Sandcastle Archivo Constructor documentación (SHFB): Using the <inheritdoc /> Tag

+0

¿Hay un atajo en Visual Studio para insertar '/// '? –

1

que acabó creando una herramienta para añadir soporte para reemplazar el/> etiqueta < inheritdoc por el post-procesamiento de los archivos de documentación XML. Disponible en www.inheritdoc.io (versión gratuita disponible).