Formating Code duplicted <summary>

DocInsight
1

Hi.
We have found a problem when formatting a unit via ‘Format Documentation’.
The formatter gets confused with the following code:

type
  TTestKlasse = class
  private
    /// <summary>
    ///   Description here
    /// </summary>
    /// <remarks>
    ///   <list type="bullet">
    ///     <item>
    ///       @created 11.10.2019 TElmers
    ///     </item>
    ///   </list>
    /// </remarks>
    Feld1, FEld2, Feld3: Integer;
  end;

Regards
Thorsten

2

@TElmers Thanks for the report! I’ve reproduced it. Filed as Duplicated summary section when format xml doc comments above separated field list · Issue #70 · devjetsoftware/docinsight-support · GitHub

I’ve noticed another issue. Do you think what fields the doc comment should be bound? All of the fields or just the first field? At present, DocInsight associate the doc to all fields but it appears that delphi compiler just bind to the first field.

3

Hi.

In my case, the developer meant the documentation for everyone (i.e. not the example, but my original problem code).
I think that if you want to have documentation for each field, then you should list them individually.

4

I created a public issue to consult the Embarcadero RSS-2852 Inconsistence between xml doc comments and attributes above separated field list

If it is by design, we will change DocInsight to behavior same as dcc (just bind to the first field). It will be a break change and we will have a migration stage if so.