Delphi Pas2Dox + Doxygen

Question

Я использую Delphi, и мне нужно подготовить документацию. Одним из возможных решений для этого является использование Doxygen с фильтром Pas2Dox.

В настоящее время я использую фильтр pas2dox-0.50rc1.exe и мастер Doxygen 1.8.3.1. Я изо всех сил пытаюсь правильно настроить Doxygen, чтобы отображать мои комментарии в Delphi, но дело в том, что я больше не уверен, каков правильный формат комментариев в Delphi. Я искал interenet, но я не могу найти учебник или пример о том, как успешно генерировать html-документацию с delphi.

Возможно, есть кто-нибудь, кто может поделиться со мной некоторыми советами о том, как достичь этого?

Мои текущие комментарии являются:

{*------------------------------------------------------------------------------ 
    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 в разделе Интерфейс:
   только методы «заявленной» в разделе ИНТЕРФЕЙСЫ будут видны в Doxygen (я не совсем понял, почему, но)

Я протестировал его с файлом, в котором были все типы delphi-комментариев. Я заменил комментарий-idicators с блокнотом ++ s заменить-все функции в следующем порядке (я полностью уверен, что есть более элегантный способ сделать это, но для меня это было удобно):

• заменить {с //
• заменить // $ с {$
• заменить (* с //

после этого, все методы (в разделе ИНТЕРФЕЙСЫ) появились в Doxygen, и я начал комментировать, используя стиль Doxygen сверху Я оставил ---, но я не думаю, что это должно быть проблемой =)