Kommentar Workflow?

[MicMic]

Hallo,
ich habe viele Variablen. Auch in verschiedenen Units.
Jede Variable kommentiere ich ausführlich (also bei der Initialisierung der Variable). Das kann dann mal ein Text mit mehreren Zeilen sein.

Mal als Beispiel:

Code:

// Für die Kontrolle des Panels XYZ. Mit False wird nicht neu gezeichnet. Ist nämlich nicht immer nötig.
// Die Variable "Tanzen" wird in der Prozedur SoundSo abgefragt und wenn sie auf "True" steht, dann wird
// dort per Invalidate das Panel neu gezeichnet.
Var Tanzen : Boolean;

Wenn in meinem Listing die Variable an 10 verschiedenen Stellen auf "True" oder "False" gesetzt wird, wäre es für mich hilfreich, wenn ich dort auch den Kommentar zu lesen hätte. Den Kommentar aber überall zu kopieren (in diesem Fall 10x) ist aber wohl nicht gerade produktiv. Schlimm wird's dann auch, wenn ich den Kommentar noch mal abändern möchte. In diesem Fall müsste ich dann den Kommentar auch an allen anderen 10 Stellen ändern. Schön wäre es, wenn ich mit der Maus auf die Variable gehen könnte und der Kommentar sozusagen als Hint angezeigt wird. Man könnte nun auch extern in einem Texteditor die Kommentare verwalten und bei Gelegenheit einfach nachschauen.

Gibt es vielleicht bessere Möglichkeiten oder Tricks/Tipps? Wie macht ihr das so?

Gruß Mic

[jobo]

Das klingt für mich etwas unübersichtlich.

Wenn man keine riesigen Codeblöcke baut, sondern funktionsbezogen arbeitet, Events nutzt, globale Variablen vermeidet, Klasseneigenschaften nutzt, dann könnte vielleicht ein zentraler Kommentar reichen.
Natürlich werden Variablen/Attribute mehrfach verwendet, aber mit Nutzung von kontextsensitiven Funktionen der IDE kann man auch mal eben zum Ursprung / Deklaration springen, nachlesen und wieder zurück.

[hoika]

Hallo,

Zitat:

ich habe viele Variablen

Das würde ich dahingehend ändern,
dass es eine Klasse (pro Unit) gibt, in der diese Variablen als Properties "residieren" (Singleton).
Dazu gibt es ein schickes SetVariableWert.
dann kann man das bessere Debuggen.

Beim Setzen des Properties gibt es einen Kommentar, warum man die Variable setzt/nicht_setzt.
Wozu die Variable gut ist, interessiert mich beim Setzen nicht, nur der Grund, warum ich die setze,

[ConstantGardener]

und hoikas "SetVariableWert" dekorierst du noch mit einem XML-Tag und dein Kommentar sollte als Hint angezeigt werden.Geht aber glaube ich nur mit Prozeduren/Funktionen nicht mit "blanken" Variablen.

Delphi-Quellcode:

/// <summary> Das ist der Kommentar der im Hint angezeigt werden soll.
/// </summary>
procedure SetVariableWert (AValue : Integer);
begin
end;

siehe auch http://docwiki.embarcadero.com/RADSt...ation_Comments

[TurboMagic]

Zitat von ConstantGardener:

und hoikas "SetVariableWert" dekorierst du noch mit einem XML-Tag und dein Kommentar sollte als Hint angezeigt werden.Geht aber glaube ich nur mit Prozeduren/Funktionen nicht mit "blanken" Variablen.

Delphi-Quellcode:

/// <summary> Das ist der Kommentar der im Hint angezeigt werden soll.
/// </summary>
procedure SetVariableWert (AValue : Integer);
begin
end;

siehe auch http://docwiki.embarcadero.com/RADSt...ation_Comments

Ergänzend dazu:

Delphi-Quellcode:

/// <summary> 
///   Das ist der Kommentar der im Hint angezeigt werden soll.
/// </summary>
/// <param AValue>
///   Das ist der Kommentar zu dem speziellen Parameter
/// </param>
procedure SetVariableWert (AValue : Integer);
begin
end;

[Uwe Raabe]

Geht auch bei Feldern einer Klasse, aber nicht mit globalen Variablen - wobei die ja sowieso verpönt sind.

[MicMic]

Danke für Eure Meinungen/Tipps...
ich muss mal schauen, wie ich am besten aufräume
Aber globale Variablen braucht man natürlich auch.

[Aviator]

Zitat von MicMic:

Aber globale Variablen braucht man natürlich auch.

Warum

[MicMic]

Zitat von Aviator:

Zitat von MicMic:

Aber globale Variablen braucht man natürlich auch.

Warum

Warum? Ich korrigiere... ich brauch sie. Warum? Weil's schön einfach ist.
Gegenfrage. Was spricht gegen globale Variablen?

[Uwe Raabe]

Zitat von MicMic:

Was spricht gegen globale Variablen?

Auf die Schnelle - siehe hier: Global Variables Are Bad