Clever Geek Handbook

New line in help

With tooltip tooltip tooltip I can display some additional comments when hovering over the class name / filename / programname, etc., like this:

/// <comments>Some comments on e.g. a class.</comments>

How can I force a newline in the displayed text?

+3


source to share


1 answer


In XE7 and XE8 the following

  public
    { Public declarations }
    /// <comments>Some comments<para/>comments on a second line</comments>
    procedure SetUp;

places the text "comments on second line" on a new line in the Help pop-up window. A little quirk is the second line indented by a couple of spaces, but if I do

/// <comments>Some comments<para>comments on a second line</para>third line</comments>

the "third line" is not indented. Indentation inconsistencies can be masked (by only indenting two spaces):

///<comments><para>Some comments</para><para>comments on a second line</para><para>third</para></comments>
procedure SetUp;

Judging by the experiments,

<p/>

XML tag used to work in XE4, but stopped working with XE7 as in my original test:

  TForm1 = class(TForm)
    CDS: TClientDataSet;
    DataSource1: TDataSource;
    DBGrid1: TDBGrid;
    Button1: TButton;
    procedure CDSCalcFields(DataSet: TDataSet);
    procedure FormCreate(Sender: TObject);
    procedure Button1Click(Sender: TObject);
  private
    ///<comments>Some comments<p/>more</comments>
    procedure AddHLIndex;

In XE4, the above displays "more" on a new line in XE4, but on the same line as "Some comments" in XE8.



I wondered if the difference in XE8 had anything to do with Castalia's presence, but I get the same difference between XE4 and XE8 with XE8 fired using the / NOCASTALIA switch.

I have not tested exhaustively, but XE8 ignores all HTML formatting tags I have tried (except

<c>
tag

mentioned by the expert), which could be the result of a deliberate change or accident, of course. On the other hand, it seems to handle HTML escape files like

&gt;

and

&lt;

but unfortunately,

&#10;

which he just ignores.

+1


source






More articles:


All Articles