2

我正在使用 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);

谢谢！！

4

1 回答 1

0

我成功地创建了一个漂亮的 doxygen 文档，其中的注释格式与您在我的 delphi 代码中的格式完全相同！

方法如下：

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

    (* comment *) or { comment }

    有 

    // comment

    为什么？根据这个关于 pas2dox 过滤器的博客条目，在你的 delphi 文件中不要使用 (* 和 *) 作为注释是至关重要的。此外，{ 和 } 包含的简单单行注释似乎也破坏了 doxygen 文档。

  2. 将您希望在 doxygen 中记录的方法放入 INTERFACE 部分：
    只有在 INTERFACE 部分中“声明”的方法才会在 doxygen 中可见（我还没有完全弄清楚为什么）

我使用具有所有类型的 delphi 注释样式的文件对其进行了测试。我按以下顺序用 notepad++ 的 replace-all 函数替换了注释标识符（我完全确定有一种更优雅的方法可以做到这一点，但对我来说它很方便）：

  • 用。。。来代替 //
  • 用 {$ 替换 //$
  • 用。。。来代替 //

之后，所有方法（在 INTERFACE 部分）都出现在 doxygen 中，我开始使用上面的 doxygen 样式进行评论。我离开了---，但我不认为这应该是一个问题=）

于 2014-06-20T15:39:14.797 回答