Delphi Pas2Dox+;编程辅助工具
我正在使用Delphi,我需要准备一些文档。其中一个可能的解决方案是将Doxygen与Pas2Dox过滤器结合使用 我目前正在使用pas2dox-0.50rc1.exe过滤器和Doxygen向导1.8.3.1。我正在努力正确设置Doxygen以在Delphi中显示我的评论,但问题是我不再确定Delphi中的正确评论格式是什么。我搜索了interenet,但找不到任何关于如何使用delphi成功生成html文档的教程或示例 有没有人可以和我分享一些如何做到这一点的技巧 我现在的评论如下:Delphi Pas2Dox+;编程辅助工具,delphi,comments,doxygen,Delphi,Comments,Doxygen,我正在使用Delphi,我需要准备一些文档。其中一个可能的解决方案是将Doxygen与Pas2Dox过滤器结合使用 我目前正在使用pas2dox-0.50rc1.exe过滤器和Doxygen向导1.8.3.1。我正在努力正确设置Doxygen以在Delphi中显示我的评论,但问题是我不再确定Delphi中的正确评论格式是什么。我搜索了interenet,但找不到任何关于如何使用delphi成功生成html文档的教程或示例 有没有人可以和我分享一些如何做到这一点的技巧 我现在的评论如下: {*--
{*------------------------------------------------------------------------------
test
@param AGraphicsOwner ParameterDescription
@param ASettingsPath ParameterDescription
@param AEngineType ParameterDescription
@return ResultDescription
------------------------------------------------------------------------------*}
constructor TBaseEngine.Create(AGraphicsOwner: HWND;
ASettingsPath: PAnsiChar;
AEngineType: byte);
谢谢 我成功地创建了一个很好的doxygen文档,其中的注释格式与您在我的delphi代码中的注释格式完全相同 以下是如何:
而不是
(* comment *) or { comment }
有
// comment
为什么?根据pas2dox过滤器的要求,在delphi文件中不使用(*和*)作为注释是至关重要的。此外,{和}所包含的简单的一行注释似乎也破坏了doxygen文档在doxygen中,只有接口部分中“声明”的方法才可见(我还没有完全弄清楚原因)
- 将{替换为//
- 将//$替换为{$
- 将(*替换为//
在那之后,所有方法(在接口部分)都出现在doxygen中,我开始使用上面的doxygen样式进行注释。我省略了--,但我认为这不应该是一个问题=)使用
{**}
应该适合您的注释。(***…)
与pasdox 0.41配合得很好