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

Question

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

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

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

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

Answer 1

Я обнаружил еще одну оговорку (что в моем случае было «неправильным»)

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

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