XML Doku wird nicht angezeigt!

[W4lt3r]

Hallo alle zusammen,
mein Problem sieht wie folgt aus:
Ich habe vor einer Weile eine Komponente Abgeleitet und jetzt habe ich für diese eine XML Doku angelegt, allerdings wird mir leider nur mein <summary> Teil in der Unit der Komponete angezeigt. Bedeutet ich habe ein Projekt die Komponente in ein Package übergeben und in das Projekt installiert. Nun habe ich noch die nötigen Einstellungen für XML getroffen und meine <summary> Teile eingetragen. Die wie schon gesagt leider nur in der Selben Unit angezeigt werden.

Delphi-Quellcode:

type
  /// <summary>
  /// TPKLabel kann ein Link einbinden und dies mit einer
  /// Markierung des Labels mit hilfe einer Beliebigen Farbe angezeigt werden.
  ///</summary>

  TPKLabel = class(TLabel)
  private
    FFarbe: TColor;
    FLink: UnicodeString;
    FFarbeOld: TColor;
  ///<summary> Sobald sich der Mauszeiger über das Label bewegt wird es makiert.</summary>
    procedure CMMouseEnter(var Message: TMessage); message CM_MOUSEENTER;
  ///<summary> Sobald der Mauszeiger das Label verlässt wird es in seine Standard Farbe zurück gesetzt.
  ///(Es spielt keine Rolle welche Farbe, es wird immer die benutzt die der Benutzer einstellt)</summary>
    procedure CMMouseLeave(var Message: TMessage); message CM_MOUSELEAVE;
    { Private-Deklarationen }
  protected
   {! <summary>Durch einen Click auf das Label öffnet sich der darin eingebundene Link.(Wenn keiner eingebunden ist öffnet sich die Homepage von MSC)</summary>}
    procedure Click; override;
    { Protected-Deklarationen }
  public
    { Public-Deklarationen }
  published
    property Farbe: TColor read FFarbe write FFarbe;
    property Link: UnicodeString read FLink write FLink;
    property OnClick;
    property OnMouseEnter;
    property OnMouseLeave;
    { Published-Deklarationen }
  end;

Danke schon mal an alle für eure Beiträge.

[Der schöne Günther]

Welche Version benutzt du? Früher beinhaltete Delphi/RAD Studio noch ein halbwegs "echtes" Documentation Insight, heute nicht mehr. Ich behelfe mir immer damit einen Ordner aus einer Delphi-Vorgängerversion rüberzukopieren damit man wenigstens halbwegs damit arbeiten kann.

[W4lt3r]

Ich benutze Delphi 10.2.

[Uwe Raabe]

Die XML-Doku steht doch im private-Teil. Den kannst du außerhalb der Unit ja sowieso nicht sehen.

[himitsu]

Zitat von Der schöne Günther:

Welche Version benutzt du? Früher beinhaltete Delphi/RAD Studio noch ein halbwegs "echtes" Documentation Insight, heute nicht mehr.

2 Jahre lang wurde "Documentation Insight" im Delphi mitgeliefert, wo der Editor und eine erweiterte Anzeige vorhanden waren.

"halbwegs damit arbeiten" : Ja, der Editor ist schon praktisch. So bleibt nur Copy&Paste, alles manuell machen, oder die billigen Code-Templates nutzen.

<summary> und andere einfache Felder werden seit Delphi 2005 vom "Help Insight" angezeigt,
außer das "Documentation Insight" wurde installiert, welches das "Help Insight" ersetzt und den größeren Funktionsumfang unterstützt+anzeigt.

Das "Help Insight" liegt in einem der IDE-Packages C:\Program Files (x86)\Embarcadero\Studio\*.0\bin und muß natürlich geladen sein. (weiß jetzt aber nicht in Welchem)

[add]

Zitat von Uwe Raabe:

Die XML-Doku steht doch im private-Teil. Den kannst du außerhalb der Unit ja sowieso nicht sehen.

Stimmt. Und das in Protected ist auskommentiert.

[W4lt3r]

Danke für die Hinweise. Mir war klar das die Inforamtionen im private Teil nicht angezeigt werden, alllerdings verstehe ich noch nicht ganz warum der <summery> Teil der Klasse nicht im Projekt angezeigt wird. Ich hab noch etwas rumprobiert, dabei ist mir aufgefallen wenn ich mein Packege in einen Extraordner im Projekt befindet und die dazugehörende .pas Datei (von der Komponente) im Projektordner liegt wird mir mein <summary> Teil angezeigt. Doch wenn ich Mein Package und meine dazu gehörige .pas Datei auserhalb des Projektes liegen hab wird es wieder nicht angezeigt. An Such- und Bibliothekspfad kann es nicht liegen da ich diese schon hinzugefügt habe.

Delphi-Quellcode:

unit LabelKoT;

interface

uses
 Winapi.Messages, Vcl.StdCtrls, Vcl.Dialogs, Vcl.Graphics, Winapi.Windows, Winapi.ShellApi, System.SysUtils, System.Classes,
 Vcl.Controls, Vcl.Forms, Vcl.ExtCtrls;

type
  /// <summary>
  /// TLabelKoT kann ein Link einbinden und dies mit einer
  /// Markierung des Labels mit hilfe einer Beliebigen Farbe angezeigt werden.
  ///</summary>
  TLabelKoT = class(TLabel)
  private
    FFarbe: TColor;
    FLink: UnicodeString;
    FFarbeOld: TColor;
  ///<summary> Sobald sich der Mauszeiger über das Label bewegt wird es makiert.</summary>
    procedure CMMouseEnter(var Message: TMessage); message CM_MOUSEENTER;
  ///<summary> Sobald der Mauszeiger das Label verlässt wird es in seine Standard Farbe zurück gesetzt.
  ///(Es spielt keined Rolle welche Farbe, es wird immer die benutzt die der Benutzer einstellt)</summary>
    procedure CMMouseLeave(var Message: TMessage); message CM_MOUSELEAVE;
    { Private-Deklarationen }
  protected
  /// <summary>Durch einen Click auf das Label öffnet sich der darin eingebundene Link.(Wenn keiner eingebunden ist öffnet sich die Homepage von MSC)</summary>
    procedure Click; override;
    { Protected-Deklarationen }
  public
    { Public-Deklarationen }
  published
    property Farbe: TColor read FFarbe write FFarbe;
    property Link: UnicodeString read FLink write FLink;
    property OnClick;
    property OnMouseEnter;
    property OnMouseLeave;
    { Published-Deklarationen }
  end;

[W4lt3r]

Danke an alle. Ich habe mein Problem glöst.

[himitsu]

Kommentare werden nicht einkompiliert und sollten so auch nicht in den DCUs drin zu finden sein.

Also Help Insight und Docu Insight müssen die PAS in den Suchpfaden finden können.
Ich weiß jetzt aber nicht welche Suchpfade/Bibliothekspfade hierfür verwendet werden.

[Sherlock]

Zitat von W4lt3r:

Danke an alle. Ich habe mein Problem glöst.

Und wie?



Sherlock