2013-08-24 273 views
1

我有一個DLL,有許多導出功能,我想分享給其他人。 有沒有辦法用參數,結果等來記錄所有現有的導出函數,這樣我就可以與他人分享而不用自己寫下來呢?文檔德爾福DLL出口

+2

您可以編寫文檔。這將補充您提供給DLL的導入單元。 –

+2

你使用的是什麼版本的Delphi?因爲後來的版本(如XE2)具有文檔功能。 –

+0

@JerryDodge我正在使用Delphi XE-4。 –

回答

4

如果您使用Delphi的更高版本(如XE2),您可能有Documentation Insight,我剛剛確認它適用於導出的函數。在你的代碼中,點擊函數/過程定義。比方說,例如...

procedure DoIt(One: Single; Two: Integer); stdcall; 
begin 
    //some other code 
end; 

一旦你點擊了這一點,光標這一功能中,按組合鍵CTRL + ALT + D。如果你有這樣的文檔功能,它會打開一個小窗口,如...

Code Documentation Window

輸入一些文件到該窗口後,它會自動插入到這個代碼:

/// <summary> 
/// This procedure does this and then that 
/// </summary> 
/// <param name="One"> 
/// This is parameter one 
/// </param> 
/// <param name="Two"> 
/// This is parameter two 
/// </param> 
/// <remarks> 
/// Use DoIt to do this and that within your Delphi project. 
/// </remarks> 
procedure DoIt(One: Single; Two: Integer); stdcall; 
begin 
    //some other code 
end; 

Refer here有關如何進一步使用本文檔的更多信息,以及this one也是如此。

使用它的最好方法是在源代碼中的任何位置,將鼠標懸停在記錄的類,函數,類型等之一上,它將顯示一個帶有記錄信息的小提示窗口。至於在DLL中使用,我從來沒有做過,但我相信你也可以在那裏使用它。

您也可以直接在代碼中直接輸入這種格式的文檔,而無需使用此窗口 - 所以基本上可以在任何版本的Delphi上執行。這是一種Microsoft標準格式,也用於其他語言。

不幸的是,我不確定Delphi的哪些版本/版本支持它。

+0

你應該更仔細地檢查窗口。這是第三方「增值」加載項。 – OnTheFly

+0

@OTheTheFly是的,我意識到這很可能是第三方加載項,這就是爲什麼我說「你可能有...」,但它確實是OP想要的,所以問題是什麼?隨着我自動安裝RAD Studio XE2,我意外地發現了它。 –

+0

@OTheTheFly即使它是一個單獨的加載項,我不得不下載並安裝自己,但這仍然與該問題完全相關。 –