德尔福 Pas2Dox + Doxygen

Question

我正在使用Delphi，我需要准备一些文档。可能的解决方案之一是将 Doxygen 与 Pas2Dox 过滤器结合使用。

我目前正在使用 pas2dox-0.50rc1.exe 过滤器和 Doxygen 向导 1.8.3.1。我正在努力正确设置 Doxygen 以在 Delphi 中显示我的注释，但问题是我不再确定 Delphi 中正确的注释格式是什么。我搜索了互联网，但找不到任何关于如何使用 delphi 成功生成 html 文档的教程或示例。

是否有人可以分享一些如何实现这一目标的技巧？

我目前的评论如下:

{*------------------------------------------------------------------------------
  test
  @param AGraphicsOwner   ParameterDescription
  @param ASettingsPath   ParameterDescription
  @param AEngineType   ParameterDescription
  @return ResultDescription
------------------------------------------------------------------------------*}
constructor TBaseEngine.Create(AGraphicsOwner: HWND;
                               ASettingsPath: PAnsiChar;
                               AEngineType: byte);

谢谢!!

Answer 1

我成功创建了一个很好的 doxygen 文档，其注释格式与我的 delphi 代码中的注释完全一样!

方法如下:

1. 将所有非 doxygen 注释替换为//:
   而不是

   (* comment *) or { comment } 
   

   有

   // comment
   

   为什么？根据 this blog entry对于 pas2dox 过滤器，不要在 delphi 文件中使用 (* 和 *) 作为注释，这一点至关重要。此外，{ 和 } 所包含的简单一行注释似乎也破坏了 doxygen 文档。

2. 将您想要在 doxygen 中查看的方法放入 INTERFACE 部分:
   只有在 INTERFACE 部分“声明”的方法才会在 doxygen 中可见(我还没有完全弄清楚为什么)

我用一个包含所有类型的 delphi 注释样式的文件对其进行了测试。我按照以下顺序用 notepad++ 的全部替换功能替换了注释指示符(我完全确定有一种更优雅的方法可以做到这一点，但对我来说这很方便):

• 将 { 替换为//
• 将//$ 替换为 {$
• 将 (* 替换为//

之后，所有方法(在接口(interface)部分)都出现在 doxygen 中，我开始使用上面的 doxygen 样式进行注释。我遗漏了 ---，但我认为这不应该是一个问题 =)