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#
8
A
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
- 1. LuaBind: ¿Cómo vincular una instancia específica de clase a Lua?
- 2. Cómo vincular una entidad a una unidad de persistencia específica
- 3. ¿Cómo obtener una línea específica de una cadena en C#?
- 4. Desplazamiento de una vista de texto a una línea específica
- 5. Cómo vincular una JList a una propiedad de clase Bean
- 6. Deshabilitar una advertencia específica en una línea específica en Xcode
- 7. cómo vincular el socket sin procesar a una interfaz específica
- 8. una forma en C++ para ocultar una función específica
- 9. ¿Hay alguna manera de restringir el acceso a un método público a solo una clase específica en C#?
- 10. C#: ¿Cómo puedo llamar a un método estático de una clase base desde un método estático de una clase derivada?
- 11. Extender un segmento de línea a una distancia específica
- 12. Java: ¿cómo limitar el acceso de un método a una clase específica?
- 13. ¿Puedo vincular un método existente a una Función LLVM * y utilizarlo desde el código compilado JIT?
- 14. Una forma curiosa de pasar un parámetro a un método
- 15. Llamar a un método de clase dentro de una clase
- 16. En WPF, ¿cómo puedo vincular una columna de cuadrícula de datos a una columna específica de una tabla de datos?
- 17. Código de C# para vincular URL en una cadena
- 18. ¿hay alguna forma de desactivar la optimización del compilador para una línea de código específica?
- 19. Cómo encontrar el código de tecla para una clave específica
- 20. Método estático de una clase estática frente a un método estático de una clase no estática (C#)
- 21. ¿Cómo puedo desplazarme a una línea específica en un cuadro de texto de WinForms usando C#?
- 22. Encontrar el autor de una línea de código en Mercurial
- 23. ¿Existe una forma integrada de identificar instancias de una clase?
- 24. Lectura de una línea específica de un archivo
- 25. ¿Puede un método en una clase interna acceder a un método de clase padre?
- 26. ¿Cómo salteo a una línea de entrada específica en Perl?
- 27. Accediendo a un miembro/método de una clase derivada virtual
- 28. ¿Es malo llamar a un método de clase como un método de una instancia?
- 29. Objetivo C - ¿Cómo agregar un método a una clase existente?
- 30. Pasar una clase Delphi a una función/método C++ que espera una clase con __thiscall methods
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
@HichemC, pruebe [this] (http://hyperaddin.codeplex.com/) –
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. –