Markieren Sie Ihre Kommentare, eine Funktion von Entwicklern für Entwickler

Kommentare sind im Leben eines Entwicklers unerlässlich. Wenn wir an einer neuen Funktion arbeiten, fügen wir oft Kommentare hinzu, die uns daran erinnern sollen. Zum Beispiel:

• um einen Teil des Codes mit einem Kollegen zu validieren,
• um eine Funktion zu refaktorisieren,
• um Code zu korrigieren, der die Leistung verlangsamt,
• um eine Methode oder eine Klasse in Abschnitte aufzuteilen,
• um das Skelett einer Klasse vorzubereiten und einen ToDo-Kommentar in jede Funktion einzufügen.

Selbst wenn Sie einen einfachen Code schreiben, versuchen Sie ihn Monate oder Jahre später zu lesen. Wird er Ihnen immer noch einfach erscheinen, oder würden Sie sich wünschen, Sie hätten Kommentare hinzugefügt?

4D v19 R4 bringt Kommentare auf eine ganz neue Ebene mit Kommentar-Tags , mit denen Sie Ihre Kommentare besser organisieren können.

Es gibt drei neue Tags, die Ihnen zur Verfügung stehen:

• MARK
• TODO
• FIXME

In diesem letzten Blogbeitrag haben wir Ihnen eine Liste im Code-Editor gezeigt, mit der Sie sich leicht in Ihrer Klasse bewegen können. Kommentare, denen diese drei Tags vorangestellt sind, werden ebenfalls in dieser Liste angezeigt.

Sie können sie innerhalb Ihrer Klassen oder Methoden verwenden.

Wie man sie verwendet

Mit dem Tag MARK können Sie Ihren Code in Abschnitte unterteilen. Sie können es auf drei verschiedene Arten schreiben. Die beiden anderen Tags, TODO und FIXME, werden auf die gleiche Weise geschrieben. Der Vorteil ist, dass sie unterschiedliche Symbole in der Liste haben, die es Ihnen ermöglichen, Ihren Code zu organisieren und Prioritäten für Ihre zukünftigen Aktionen zu setzen.

Hier ist ein Beispiel mit einer ORDA-Klasse:

Die Funktionen und Kommentar-Tags werden in der Reihenfolge angezeigt, in der sie innerhalb der Klasse und Methode erscheinen. Wenn Sie möchten, können Sie die Funktionen und Kommentar-Tags einer Klasse in alphabetischer Reihenfolge anzeigen lassen, indem Sie Cmd unter macOS oder Alt unter Windows gedrückt halten, bevor Sie das Menü aufrufen.

Wie geht’s weiter?

Sind Sie bereit, Ihr Programmierspiel mit dieser neuen Funktion zu verbessern? Sagen Sie uns, was Sie von dieser neuen Möglichkeit halten, Ihren Code zu organisieren und in Ihren Klassen oder Methoden zu navigieren. Wir warten auf Sie in unserem Forum.