Question

我使用Excel Dna创建.NET xlls并在我的addin和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 /// comments生成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

使用Excel Dna进行文档编制

1 个答案: