使用Excel做文档Dna

Question

我已经使用Excel Dna创建.NET xlls并将其用于我的插件和Excel工作表函数。 我也使用ExcelDnaPack.exe打包我的xll。

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

感谢， 玛尼

Answer 1

首先，Excel的DNA可以让你融入与功能和不同的参数描述的Excel函数向导。这些添加到您的功能使用属性：

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

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

如果你有一个帮助文件，说.chm格式，你可以告诉Excel的DNA挂钩这样的帮助链接：

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

如何获得帮助文件？ C＃或VB.NET编译器可以从代码中的xml ///注释生成一个xml文件。这个.xml文件是由Sandcastle处理的 - 下面是关于该部分的整个讨论：Generating Documentation from C# XML Comments。

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

使用显示整个加载项的帮助文件的按钮向Excel-DNA加载项添加功能区也很常见。

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