使用Excel Dna做文档

我已经使用Excel Dna来创build.NET的XLS，并在我的插件和Excel工作表函数中使用它。 我也使用ExcelDnaPack.exe打包我的xll。

我想知道如果Excel支持，任何方式来生成我的图书馆API的文档。

谢谢，玛尼

Answer 1

首先，Excel-DNA允许您将Excel函数向导集成到函数和不同参数的描述中。 这些被添加到您的function使用属性：

[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) {...} 

function向导还允许每个function的帮助链接。

如果你有一个帮助文件，比如说.chm格式，你可以告诉Excel-DNA来连接这个帮助链接：

 [ExcelFunction(HelpTopic="MyHelp.chm!102")] public static double MyFunction() ... 

如何获得帮助文件？ C＃或VB.NET编译器可以从代码中的xml ///注释生成一个xml文件。 这个.xml文件是通过类似Sandcastle的方式进行处理的 – 下面是关于这个部分的全面讨论： 从C＃XML注释生成文档 。

但Excel-DNA目前没有任何function和主题自动关联。 我不确定从Sandcastle输出中找出生成的TopicIds是多么困难，或者是从xml注释中的代码中设置它们。 如果这是一个问题，将来可能会自动添加主题连接或帮助生成器工具，这可能是添加到Excel-DNA的一个很好的function。

使用显示整个加载项的帮助文件的button，将function区添加到Excel-DNA加载项中也是很常见的。

编辑：现在有一个用户提供的项目，处理Excel-DNA更容易生成帮助文件。 请参阅https://github.com/mndrake/ExcelDnaDoc