Документация HelpInsight в Delphi 2007

Question

Я использую D2007 и пытаюсь задокументировать свой исходный код, используя функцию HelpInsight (предоставляется с D2005).В основном я заинтересован в том, чтобы заставить работать подсказки HelpInsight.В результате различных веб-серфингов и экспериментов я обнаружил следующее:

1. Использование стиля комментариев с тройной косой чертой (///) работает чаще, чем другие документированные стили комментариев.т. е.: {*! comment *} и {! comment }
2. Комментарии должны предшествовать заявлению, для чего они предназначены.В большинстве случаев это будет означать размещение их в интерфейсном разделе кода.(Очевидное исключение касается типов и функций, которые недоступны извне текущего модуля и поэтому объявлены в блоке реализации.)
3. Первый комментарий не может быть предназначен для функции.(т.е.это должно быть для типа - или, по крайней мере, кажется, что анализатор должен был увидеть ключевое слово "type", прежде чем сработает функция HelpInsight)

Несмотря на соблюдение этих "правил", иногда Help-insight просто не находит комментарии, которые я написал.Один файл не выдает правильные подсказки HelpInsight, но если я включу этот файл в другой фиктивный проект, он будет работать должным образом.

Есть ли у кого-нибудь другие указания / хитрости для того, чтобы заставить HelpInsight работать?

Answer 1

Я обнаружил еще один нюанс (который в моем случае был "неправильным").

Похоже, что устройство с комментариями HelpInsight должен быть явно добавленным в проект.Недостаточно просто указать модуль в пути, который ищется при компиляции проекта.

Другими словами, модуль должен быть включен в файл проекта .dpr / .dproj.(Используя пункт меню Проект | "Добавить в проект")