Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Die Delphi-IDE (https://www.delphipraxis.net/62-die-delphi-ide/)
-   -   Quelltext formatieren [Strg-D], Kommentare ausschliessen (https://www.delphipraxis.net/191503-quelltext-formatieren-%5Bstrg-d%5D-kommentare-ausschliessen.html)

norwegen60 22. Jan 2017 10:39

Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Hallo,

weiß jemand ob es eine Möglichkeit gibt Kommentar von der Autoformatierung auszuschliessen? Wenn ich folgende Kommentare habe

Delphi-Quellcode:
{+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Header

================================================================================
Funktionen
  SetBit     = Setzt das Bit an einer bestimmten Stelle einer Integerzahl.
                  i:=SetBit(5,2,True) => i:=7
  StrAnz     = Ermittelt in einem String die Anzahl eines anderen Strings
                  B:=StrAnz('l','Alles klar'); => B=3
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++}
und per [Strg-D] die Autoformatierung durchführe, sieht der Kommentar so aus
Delphi-Quellcode:
{+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  Header

  ================================================================================
  Funktionen
  SetBit     = Setzt das Bit an einer bestimmten Stelle einer Integerzahl.
  i:=SetBit(5,2,True) => i:=7
  StrAnz     = Ermittelt in einem String die Anzahl eines anderen Strings
  B:=StrAnz('l','Alles klar'); => B=3
  +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ }
Also nicht gerade besser lesbar
Es geht nicht nur um die Erklärung von Funktionen die man vielleicht auch per Headerformate erklären könnte sondern um alle Arten von Kommentare.

Danke
Gerd

DeddyH 22. Jan 2017 10:44

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
"Tools - Optionen - Formatierung - Delphi - Einzug - Allgemein - Kommentare einziehen" auf Nein setzen.

norwegen60 22. Jan 2017 11:20

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Super. Danke. Ich hatte es mit Leerzeichen - Leerzeichen für Kommentare versucht, was nicht geklappt hat

DeddyH 22. Jan 2017 11:23

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Die Formatierungsoptionen sind auch nicht unbedingt übersichtlich ;)

himitsu 22. Jan 2017 12:15

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Liste der Anhänge anzeigen (Anzahl: 1)
Alternativ kannst du auch auf XMLDoc umsteigen. Es hat auch den Vorteil, dass diese Hilfe über's HelpInsight überall im Code verfügbar ist, also bei jedem Aufruf der Funktionen.
Der Documentation Insight Editor fehlt ja leider inzwischen wieder, aber die Grundfunktionen können immernoch verwendet werden.

Am Einfachsten man macht sich eigene Vorlagen (wenn man Documentation Insight nicht kaufen möchte), oder man macht es aus dem Kopf (gibt ja nur eine handvoll Typen), bzw. verwendet die unpraktischeren Codevorlagen vom Delphi.

norwegen60 22. Jan 2017 12:37

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Zitat:

Zitat von himitsu (Beitrag 1359607)
Alternativ kannst du auch auf XMLDoc umsteigen.

Ja, das ist ein anderes Thema. Es ging mir aber allgemein um Kommentare und da war die Kurzbeschreibung das erste was mir in die Finger kam.

Aviator 22. Jan 2017 12:58

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Zitat:

Zitat von himitsu (Beitrag 1359607)
Am Einfachsten man macht sich eigene Vorlagen (wenn man Documentation Insight nicht kaufen möchte), oder man macht es aus dem Kopf (gibt ja nur eine handvoll Typen), bzw. verwendet die unpraktischeren Codevorlagen vom Delphi.

Oder man installiert sich CnPack. Dort sind im Eingabehelfer die XML-Dok Kommentare enthalten und man kann die dann einfach übernehmen und muss sie nur noch ausfüllen.

Uwe Raabe 22. Jan 2017 15:28

AW: Quelltext formatieren [Strg-D], Kommentare ausschliessen
 
Zitat:

Zitat von Aviator (Beitrag 1359611)
Zitat:

Zitat von himitsu (Beitrag 1359607)
Am Einfachsten man macht sich eigene Vorlagen (wenn man Documentation Insight nicht kaufen möchte), oder man macht es aus dem Kopf (gibt ja nur eine handvoll Typen), bzw. verwendet die unpraktischeren Codevorlagen vom Delphi.

Oder man installiert sich CnPack. Dort sind im Eingabehelfer die XML-Dok Kommentare enthalten und man kann die dann einfach übernehmen und muss sie nur noch ausfüllen.

Die vorhandenen Bordmittel in Form der XMLDOC-Templates para, param, remarks, returns und summary reichen vielleicht auch für den Anfang.


Alle Zeitangaben in WEZ +1. Es ist jetzt 06:08 Uhr.

Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz