![]() |
KommentareEd42 bietet eine umfangreiche Unterstützung bei der Erstellung und Pflege von Kommentaren. Dabei werden generell zwei Formen von Kommentaren unterschieden:
/*-------------------------------------------------------------------------*/ /* Falls kein Datum angegeben wird (du == 0) werden als Default Striche */ /* eingesetzt ... */ /*-------------------------------------------------------------------------*/ strcpy(s, "--------------"); if (du == 0) return (s); cvdatetime(&dttm, du); switch (datum_darstellung) { case DARST_NN_NN_NN: // DD.MM.YY sprintf(s, "%02d.%02d.%02d", dttm.dttm_mday, dttm.dttm_month, dttm.dttm_year % 100); break; case DARST_NN_MON_NN: // DD.MON YY sprintf(s, "%02d.%s.%02d", dttm.dttm_mday, monat_kurz_bez[dttm.dttm_month-1], dttm.dttm_year % 100); break; default: break; }
Ed42 bietet zwei alternative Methoden zur Strukturierung von zeilenübergreifenden
Kommentaren:
|
Konstrukt | Informationen, die angegeben werden können |
Modul | Name des Moduls, Aufgabe des Moduls, Abhängigkeiten des Moduls (z.B. von anderen Modulen), Autor , Erstellungsdatum, Änderungen (mit dem jeweiligen Datum der Änderung, Autor und Beschreibung der Änderung), offene Punkte. Für Autor- und Firmenangaben werden die über Hilfe|Info eingegebenen Benutzerinformationen als Standardvorgaben verwendet. |
Klasse | Name, Attribute (mit Name, Typ, Modus und Erläuterung), Methoden (mit Name und Erläuterung), Aufgabe, Implementierungshinweise, Autor, Erstellungsdatum, Änderungen (mit dem jeweiligen Datum der Änderung, Autor und Beschreibung der Änderung). Für Autor- und Firmenangaben werden die über Hilfe|Info eingegebenen Benutzerinformationen als Standardvorgaben verwendet. |
Interface | Name, Attribute (mit Name, Typ, Modus und Erläuterung), Methoden (mit Name und Erläuterung), Aufgabe. |
Struktur | Name, Elemente (mit Name, Typ, und Erläuterung), Aufgabe. |
Prozedur | Name, Name der Klasse (nur bei Methoden), Parameter (mit Namen, Typ, Modus und Erläuterung), erzeugte Exceptions, Aufgabe und Implementierungshinweise. |
Funktion | Name, Name der Klasse (nur bei Methoden), Parameter (mit Namen, Typ, Modus und Erläuterung), Rückgabewert (mit Typ und Erläuterung), erzeugte Exceptions, Aufgabe und Implementierungshinweise. |
Der automatisch von Ed42 erstellte Kommentar spiegelt die Informationen wieder, die eingegeben wurden. Der Kommentar wird oberhalb der aktuellen Zeile in das aktuelle Dokument eingefügt. Zur Formatierung des Kommentars werden die Projekteinstellungen berücksichtigt (s.o.).
Beispiel: Das folgende Codefragment enthält einen für eine Funktion automatisch formatierten Kommentar.
/*****************************************************************************/ /*-Funktion: PV_SetzeAbgang */ /*---------------------------------------------------------------------------*/ /*-Aufgabe: */ /* Festlegen des Abgangsortes. Die nachfolgenden Tarifierungen verwenden den */ /* eingestellten Abgangsort als Startpunkt bei der Suche von Relationen. */ /*---------------------------------------------------------------------------*/ /*-Parameter: */ /* Input betreiber_id : uint */ /* Id des Betreibers (in der Regel die Id des Verbundes) */ /* Input ta_tarif_typ_id : ulong */ /* Kodiert, welche Angebote und Verkehre verkauft werden duerfen */ /* Input sprach_id : uint */ /* Id der verwendeten Sprache (deutsch = 400) */ /* Input waehrung_id : uint */ /* Id der verwendeten Waehrung (DM = 276) */ /* Input bezeichner : char * */ /* Bezeichner der Ausgabestelle */ /* Input abgangsort_position : ulong */ /* Position der Ausgabestelle */ /*---------------------------------------------------------------------------*/ /*-Funktionsergebnis: */ /*-Typ: bool */ /* TRUE = Setzen des Abgangsortes war erfolgreich, FALSE sonst */ /*---------------------------------------------------------------------------*/ /*-Implementierungshinweise: */ /*****************************************************************************/ bool PV_SetzeAbgang(uint betreiber_id, ulong ta_tarif_typ_id, uint sprach_id, uint waehrung_id, char *bezeichner, ulong abgangsort_position);Strukturierte Kommentare ändern: Die Änderung wird analog zur Änderung von einfachen Kommentaren angestoßen (Kommentare|Kommentar modifizieren bzw. über PopUp-Menü). Dem Bediener wird ein Dialog angeboten, der die gleichen Eingabemöglichkeiten wie bei der Erstellung eines strukturierten Kommentars (nach der Wahl des Konstrukts) enthält. Die Informationen des bestehenden Kommentars werden in den Dialogfeldern zur Änderung dargestellt, d.h. Ed42 ist in der Lage, den vorhandenen strukturierten Kommentar zu parsen. Daraus ergibt sich die Notwendigkeit, daß mit Hilfe von Ed42 erzeugte Kommentare nicht verändert werden; ansonsten können Informationen bei der Änderung eines Kommentars verloren gehen (es können im Quelltext durchaus Änderungen an Kommentaren vorgenommen werden; wichtig ist, daß die Struktur der Kommentare nicht verändert wird. Z.B. stellt das Verrutschen der schließenden Kommentarzeichen durch Textänderungen kein Problem dar).
Strukturierte Kommentare formatieren: Wir ein Strukturierter Kommentar im Quelltext geändert, kann er analog zu einem einfachen Kommentar über über Kommentare|Kommentar formatieren bzw. den entsprechenden Menüpunkt des PopUp-Menüs, das über die rechte Maustaste erreichbar ist, formatiert werden. Für die Formatierung gelten die unter Strukturierte Kommentare erstellen gemachten Aussagen. Zur Modifikation von strukturierten Kommentaren vgl. aber Strukturierte Kommentare ändern.
Ersetzen von Umlauten: Sowohl für einfache als auch für strukturierte Kommentare bietet Ed42 die Möglichkeit an, alle Umlaute in Kommentaren zu ersetzen, bevor sie in den Quellcode eingearbeitet werden. Das Feature kann über die Projektoptionen (Registerkarte Sprache/Kommentare) aktiviert werden.
Last Change: 27.10.2001
© Copyright by Stefan Brüning. All rights reserved |