我使用 Excel Dna 创建 .NET xlls 并将其用于我的插件和 Excel 工作表函数。我还使用 ExcelDnaPack.exe 来打包我的 xll。
我想知道 excel dna 是否支持为我的库 API 生成文档的任何方法。
谢谢,玛尼
首先,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 之类的东西处理 - 这是关于这部分的完整讨论:从 C# XML 注释生成文档。
但 Excel-DNA 目前没有任何东西可以自动关联函数及其主题。我不确定从 Sandcastle 输出中找出生成的 TopicId 或从 xml 注释中的代码设置它们有多难。如果这是一个问题,自动主题连接甚至帮助生成器工具可能是将来添加到 Excel-DNA 的一个不错的功能。
使用显示整个加载项的帮助文件的按钮向 Excel-DNA 加载项添加功能区也很常见。
Edit: There is now a user-contributed project that processes Excel-DNA to generate help files more easily. See https://github.com/mndrake/ExcelDnaDoc