Расширение документации класса и живых шаблонов - PullRequest
Новая
       19

Расширение документации класса и живых шаблонов

4 голосов
/ 25 сентября 2011

Я играю с документацией по коду и живыми шаблонами, и я совсем не понимаю.

Я прочитал Статья доктора Боба о создании документации и вики-статей о живых шаблонахно у меня есть одна проблема с описанием класса.

По описанию класса я понимаю поведение IDE, когда наводю курсор мыши на объявление класса.

Например, у меня есть такой класс с его описанием:

type
  {$REGION 'TMyClass'}
    /// <summary>
    /// Summary works
    /// </summary>
    /// <remarks>
    /// Remarks works
    /// </remarks>
    /// <exception cref="www.some.link">This works</exception>
    /// <list type="bullet">
    /// <item>
    /// <description>description does not work</description>
    /// </item>
    /// <item>
    /// <description>description does not work</description>
    /// </item>
    /// </list>
    /// <permission cref="www.some.link">This works</permission>
    /// <example>
    /// <code>
    /// Code example does not work
    /// </code>
    /// </example>
  {$ENDREGION}
  TMyClass = class
  private
    a, b, c: Integer;
  public
  end;

И позже в коде у меня есть такое объявление: 

var
  MyObject: TMyClass;

Когда я наведу курсор мыши на тип класса, у меня есть такое описание:

Class description

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

Я использую Delphi 2009 Proffesional.

Ответы [ 2 ]

8 голосов
/ 25 сентября 2011

Поддерживается только ограниченный набор тегов. Лучшая документация об этом материале, о которой я знаю, - это Руководство по документации Delphi от DevJET Software (в конце «Оглавления» есть ссылка на PDF).

3 голосов
/ 26 сентября 2011

Теги, которые поддерживает Help Insight, описаны в интерактивной справке и Delphi docwiki .Они являются подмножеством тегов поддержки тегов справки C #.Никакие другие теги, кроме перечисленных на сайте Embarcadero, похоже, не поддерживаются (я пробовал их).Единственными другими вещами, которые работают (и являются обязательными), являются "<", ">" и "" ".

Обновление

Кажется, что есть некоторые продукты, которые позволяют вам использовать полныйсинтаксис, как, например, описано в Руководстве по документации Delphi, на которое ссылается @ain. Но для этого необходимо купить коммерческий продукт , такой как DevJet Documentation Insight , который не следует путать с Help Insight IDE поддерживает начиная с Delphi 2006.

Как вы узнали, и я тоже, только подмножество, описанное в Delphi docwiki , поддерживаетсяголая IDE без коммерческих продуктов. Существует также документация, которая поддерживается интерфейсом моделирования, но опять же отличается. В обычной IDE вы можете использовать только те теги, которые вы и я уже нашли.

...