He usado Excel Dna para crear .NET xlls y usarlo en mis funciones de hoja de cálculo de complemento y Excel. También uso ExcelDnaPack.exe para empaquetar mi xll.Hacer documentación usando Excel Dna
Me preguntaba si excel dna admite alguna forma de generar documentación para las API de mi biblioteca.
Gracias, Mani
En primer lugar, Excel-ADN permite integrar en el Asistente para funciones de Excel con las descripciones de las funciones y los diferentes argumentos. Estos se agregan a su función mediante los atributos:
[ExcelFunction(Category="My functions", Description="My useful function")]
public static double MyFunc(
[ExcelArgument(Description="is an important parameter.")] double param1,
[ExcelArgument(Description="is unimportant.")] double param2)
{...}
El asistente de funciones también permite un enlace de ayuda para cada función.
Si usted tiene un archivo de ayuda, por ejemplo en formato .chm, se puede decir Excel-ADN para conectar el enlace de ayuda de esta manera:
[ExcelFunction(HelpTopic="MyHelp.chm!102")]
public static double MyFunction() ...
¿Cómo obtener el archivo de ayuda? El compilador C# o VB.NET puede generar un archivo xml a partir de los // xml comentarios en su código. Este archivo .xml es procesado por algo como Sandcastle. Aquí hay una discusión completa sobre esa parte: Generating Documentation from C# XML Comments.
Pero Excel-DNA no tiene nada en este momento para relacionar automáticamente las funciones y sus temas. No estoy seguro de lo difícil que es descifrar los TopicIds generados de la salida de Sandcastle, o establecerlos desde el código en el comentario xml. Si es un problema, una conexión automática de temas o incluso una herramienta de generador de ayuda podría ser una buena característica para agregar a Excel-DNA en el futuro.
También es común agregar una cinta a su complemento Excel-DNA con un botón que muestra un archivo de ayuda para todo el complemento.
Edit: Ahora hay un proyecto contribuido por el usuario que procesa Excel-DNA para generar archivos de ayuda más fácilmente. Ver https://github.com/mndrake/ExcelDnaDoc