2012-10-07 24 views
8

Quiero compilar una especie de documentación utilizando enlaces en el código que apuntan a un objetivo. El objetivo podría ser Class o Method o una línea de código específica. (apuntando a una línea de código específica es la más importante)
Pensé en una extensión para VS2010 o una etiqueta de comentario específica.
¿Hay alguna forma de hacer enlaces de este tipo?Una forma de vincular a una clase, un método, especialmente una línea de código específica en el comentario de C#

+3

Javadoc fue capaz de hacer precisamente este tipo de cosas. Cuando Microsoft lanzó .Net 1.1, intentaron imitar a Javadoc con "NDoc". Luego mató a NDoc a favor de "Sandcastle": http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx. Su XML actual es, francamente, un desastre ... SUGERENCIA: considere usar [Doxygen] (http://www.stack.nl/~dimitri/doxygen/) en su lugar. – paulsm4

+0

@HichemC, pruebe [this] (http://hyperaddin.codeplex.com/) –

+1

Lo probé y creo que funciona bien, solo registre el complemento y lea Help.htm para aprender a usarlo . Si tiene algún problema (porque está diseñado para VS 2005 y 2008) puede reconstruir la solución (es de código abierto) y debería funcionar bien. –

Respuesta

9

Xml comment + sandcastle puede ser lo que necesita. Puede hacer referencia a la clase o método especificado usando

<see cref=".."/> 

y parámetros de referencia usando

<paramref name=".."/> 

Sin embargo, no hay método directo para hacer referencia a ciertas líneas de código, pero puede hacer referencia a cierta #region utilizando

<code source="$sourcefile$" region="$regionname$"/> 

Por favor, consulte: XML Comments Guide Página 20.

Tenga en cuenta que el código que hace referencia se mostrará directamente en lugar de un enlace. No es perfecto, pero espero que ayude.

+0

Respuesta bastante útil. Gracias – HichemSeeSharp

Cuestiones relacionadas