delphi - 文档 Delphi DLL 导出

Question

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

Answer 1

如果您使用的是更高版本的 Delphi，例如 XE2，您可能有Documentation Insight，我刚刚确认它适用于导出的函数。在您的代码中，单击函数/过程定义。比如说……

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

单击此按钮且光标位于此功能内后，请按组合CTRL + ALT + D。如果您有此文档功能，它将打开一个小窗口，例如...

在此窗口中键入一些文档后，它会自动将其插入到您的代码中：

/// <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;

有关如何进一步使用本文档以及本文档的更多信息，请参阅此处。

使用它的好处是在您的源代码中的任何地方，您将鼠标悬停在您记录的类、函数、类型等之一上，它将显示一个带有记录信息的小提示窗口。至于在 DLL 中使用，我从来没有这样做过，但我相信你也可以在那里使用它。

您还可以在不使用此窗口的情况下直接在代码中输入这种格式的文档，因此基本上您可以在任何版本的 Delphi 上执行此操作。它是一种 Microsoft 标准格式，也用于其他语言。

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