文档Delphi DLL导出

时间:2013-08-24 17:28:00

标签: delphi dll documentation delphi-xe4

我有一个包含许多导出功能的DLL,我想与其他人分享。 有没有办法用参数,结果等来记录所有现有的导出功能,这样我就可以与他人分享它们而不用自己写下来?

1 个答案:

答案 0 :(得分: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的哪个版本/版本支持它。