Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Sonstige Werkzeuge (https://www.delphipraxis.net/63-sonstige-werkzeuge/)
-   -   Mehrfarbige Kommentare in Delphi? (https://www.delphipraxis.net/51570-mehrfarbige-kommentare-delphi.html)

Matze 15. Aug 2005 10:25


Mehrfarbige Kommentare in Delphi?
 
Hallo zusammen!

Ja das klingt erstmal sehr unsinnig, doch ich hätte gerne mehrfarbige Kommentare in Delphi, um genau zu sein, zweifarbige. Innerhalb von Prozeduren und Fuktionen etc. sollen Kommentare eine andere Farbe haben, als außer halb. Gibt es sowas irgendwie?

Grund ist der, dass der Code so (für mich) deutlich übersichtlicher wird, gerade, wenn er etwas länger ist. Im Folgenden ein kleines Beispiel, wobei man es da evtl. nicht versteht, wieso es übersichtlicher sein soll:

Aktuell:
Code:
[color=#008000]//==============================================================================
// Constructor to create TabSheets
//==============================================================================[/color]
[b]constructor[/b] TTabDoc.Create(AOwner:TComponent; DocType: integer; title: [b]string[/b]; FileName: string);
[b]var[/b]
  TBItem: TTBCustomItem;
[b]begin[/b]
  [color=#008000]//Show filename in caption[/color]
  Form1.Caption := ProgName + ' - ' + title;

  [b]inherited[/b] Create;

  [color=#008000]//Create Tabs to switch between documents[/color]
  DocTab := TTabSheet.Create(Application.MainForm); [color=#008000]//Maybe here a comment[/color]
  DocTab.PageControl := Form1.PageControl5;
  DocTab.Caption := title;

  [color=#008000]//Another comment[/color]
übersichtlicher finde ich folgendes, da die Funktionen einfach hervorgehoben werden:

Code:
[color=#008000]//==============================================================================
// Constructor to create TabSheets
//==============================================================================[/color]
[b]constructor[/b] TTabDoc.Create(AOwner:TComponent; DocType: integer; title: [b]string[/b]; FileName: string);
[b]var[/b]
  TBItem: TTBCustomItem;
[b]begin[/b]
  [color=#FFC600]//Show filename in caption[/color]
  Form1.Caption := ProgName + ' - ' + title;

  [b]inherited[/b] Create;

  [color=#FFC600]//Create Tabs to switch between documents[/color]
  DocTab := TTabSheet.Create(Application.MainForm); [color=#FFC600]//Maybe here a comment[/color]
  DocTab.PageControl := Form1.PageControl5;
  DocTab.Caption := title;

  [color=#FFC600]//Another comment[/color]
Gibt es sowas? :stupid:

shmia 15. Aug 2005 10:43

Re: Mehrfarbige Kommentare in Delphi?
 
Gegenfrage: Beherrscht denn Delphi 2005 das Codefolding ??
(ich armer Tropf muss hier immer noch mit D5 arbeiten)
Falls ja, dann müsste eigentlich auch ein Kommentar eingeleitet mit 3 mal / ein Sonderbedeutung erhalten.
In .Net Visual Studio werden Kommentare mit /// zum Platzhalter für eingefalteten Code.

dahead 15. Aug 2005 10:50

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Gibt es sowas?
Soweit ich weiß, nicht.
wie sollte delphi die unterschiedlichen kommentare erkennen? es fangen ja alle mit // oder {} an.
das einzige was mir hierzu noch einfällt ist der Shortcut Strg-#, der einen kommentar in der aktuellen Zeile erstellt.

edit: habe dazu etwas in der onlinehilfe gefunden:

Zitat:

Comments are ignored by the compiler, except when they function as separators (delimiting adjacent tokens) or compiler directives.
There are several ways to construct comments:
{ Text between a left brace and a right brace constitutes a comment. }
(* Text between a left-parenthesis-plus-asterisk and an asterisk-plus-right-parenthesis is also a comment *)
// Any text between a double-slash and the end of the line constitutes a comment.
Comments that are alike cannot be nested. For instance, {{}} will not work, but (*{}*)will. This is useful for commenting out sections of code that also contain comments.

A comment that contains a dollar sign ($) immediately after the opening { or (* is a compiler directive. For example,
{$WARNINGS OFF}
tells the compiler not to generate warning messages.

nailor 15. Aug 2005 10:50

Re: Mehrfarbige Kommentare in Delphi?
 
codefolding geht. aber soweit ich weiß, über die region-befehle bzw. automatisch bei jeder funktion/procedure. die dreifachkommentare sind zumindest bei c# für die xml-doku

Olli 15. Aug 2005 10:58

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Zitat von shmia
In .Net Visual Studio werden Kommentare mit /// zum Platzhalter für eingefalteten Code.

Igitt. Das kollidiert ja dann direkt mit einschlägigen Doc-Tools.

Robert_G 15. Aug 2005 11:09

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Zitat von Olli
Zitat:

Zitat von shmia
In .Net Visual Studio werden Kommentare mit /// zum Platzhalter für eingefalteten Code.

Igitt. Das kollidiert ja dann direkt mit einschlägigen Doc-Tools.

Du hast doch gar keine Ahnung. ;)
Wenn man /// über eine Mthode tippt, bekommt man automatisch den Rumpf für die XML Doku, man hat sogar Code completion für XML Tags und ein anderes Highlighting als normale Kommentare.
Da das etwas verbose aussieht, kann man sie zusammenklappen.
Das schöne ist, dass man nun nicht nur eine Doku daraus rezeugen kann, sondern dass du diese Infos auch im Code als toolTip siehst.
C# in D2005 stellt das als normale Kommentare da, die man nicht einklappen kann -> ziemlich unübersichtlich.

@Topic
Wenn man viele lange EMthoden hat, ist das oft ein Zeichen dafür, dass man das noch auf eine weitere Klasse aufteilen kann. Ich selbst benutze fast nie Kommentare innerhalb von Methoden. Höchstens an heiklen Punkten...
<summary> und <remarks> reichen mir zur Beschreibung eigentlich aus. ;)

Matze 15. Aug 2005 11:12

Re: Mehrfarbige Kommentare in Delphi?
 
@dahead: Der Compiler müsste nur schauen, wo sich der Kommentar befindet. Ist er innerhalb von Prozeduren, Funktionen, Konstruk- oder Destruktoren, soll er sie andersfarbig darstellen.

Und die verschiedenen Arten von Kommentaren kenne ich schon, nur sind diese leider alle in der selben Farbe.

@Robert: Sicher, ich würde dort auch ohen Kommentare auskommen, da meine Variablen alle ganz passende Namen haben, doch finde ich es als Gedankenstütze, wenn man sich ein Projekt nach Mmonaten wieder anschaut, ganz praktisch.

Robert_G 15. Aug 2005 11:21

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Zitat von Matze
@dahead: Der Compiler müsste nur schauen, wo sich der Kommentar befindet. Ist er innerhalb von Prozeduren, Funktionen, Konstruk- oder Destruktoren, soll er sie andersfarbig darstellen.

Seid wann ist der Compiler für Syntax highlighting verantwortlich? :shock:
Vielleicht findest du auch einen AddIn, der das macht. ;)

Matze 15. Aug 2005 11:46

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Zitat von Robert_G
Seid wann ist der Compiler für Syntax highlighting verantwortlich? :shock:
Vielleicht findest du auch einen AddIn, der das macht. ;)

http://www.seidseit.de

Jo, da hast du recht, ich meine natürlich den Highlightning Parser.

Olli 15. Aug 2005 12:13

Re: Mehrfarbige Kommentare in Delphi?
 
Zitat:

Zitat von Robert_G
Zitat:

Zitat von Olli
Igitt. Das kollidiert ja dann direkt mit einschlägigen Doc-Tools.

Du hast doch gar keine Ahnung. ;)

Da hast du recht. Ich bin ja auch Fan von "Selberwählen welches Doc-Tool ich benutze" ... der Olli ist ein Gewohnheitstier :zwinker:


Alle Zeitangaben in WEZ +1. Es ist jetzt 14:55 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