2011-11-17 89 views
8

我已經使用Excel Dna創建.NET xlls並將其用於我的插件和Excel工作表函數。 我也使用ExcelDnaPack.exe打包我的xll。使用Excel做文檔Dna

我想知道如果Excel支持,任何方式來生成我的圖書館API的文檔。

感謝, 瑪尼

回答

13

首先,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