excel - 使用 Excel Dna 进行文档编制

Question

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

我想知道 excel dna 是否支持任何为我的库 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