Search code examples
delphixml-documentationdelphi-10.3-rio

XMLDoc for Delphi unit name

Is it possible to document unit purpose in Delphi using <summary> XMLDoc tag? How?

I've tried put summary both before unit:

/// <summary> Unit purpose: test </summary>
unit Test;

and after:

unit Test;
/// <summary> Unit purpose: test </summary>

Both approaches gives nothing. Checked by hovering over the unit name in the other unit. At the same time hovering works for other identifiers in the same units

Solution

  • According to Embarcadero's documentation:

    XML Documentation Comments

    You can use the following elements in XML DOC comments:

    <summary>

    A summary of the target function or class

    So no, it does not appear that you can apply a <summary> to the unit as a whole.