XML-комментарии в стиле C # в Delphi 2010
-
18-09-2019 - |
Вопрос
есть ли в Delphi 2010 XML-комментарии в стиле C #, которые отображаются при наведении курсора мыши на вызов метода?
/// <summary>
/// My comment here
/// </summary>
Решение
Я только что попробовал это в D2007, и это работает.Я поместил ваш тестовый комментарий над объявлением метода (внутри объявления класса) и перестроил.Теперь, когда вы наведете курсор на вызов этого метода, вы увидите "Мой комментарий здесь" внутри всплывающей подсказки.
У вас должна быть включена эта штука для оценки HTML, чтобы это сработало.Смотрите Параметры -> Параметры редактора -> Анализ кода -> Описание символа (переведено с немецкого языка IDE).
Другие советы
Это действительно работает - в Delphi 2007 и 2009 с этим есть проблемы - вам нужно иметь type keywork перед каждым классом, иначе он выбирает только первый набор документации (понятия не имею, почему), и если вы нажмете опцию "Создать XML documentation", кажется, что он теряется при компиляции большого количества модулей и сдается - я надеюсь, что это исправлено в Delphi 2010.
Сказав, что встроенная документация лучше, чем отсутствие документации вообще!
Эта ссылка перейти на Embarcadero - это, пожалуй, единственное, что я могу найти, хотя я думаю, что в версиях Architect и Enterprise Delphi есть утилиты для создания внешней документации.