Die Daten für Methoden und Procduren werden aus Kommentaren in den entsprechenden Methoden oder Prozeduren gewonnen.
Alternativ dazu kann eine Quelldatei angegeben werden. Beschreibungen für Eigenschaften,Objkete, Klassen und Dateien werden auch aus der Quelldatei gewonnen.
Siehe Beschreibung.
Dieser plug in gestattet die Benutzung des "tag" Stieles für die Dokumentation von Methoden und Proceduren. Der ursprüngliche "Prefix" Stiel bleibt erhalten. Beide Stiele können gemischt werden. Es gibt jedoch die Möglichkeit, den Prefix Stiel komplett zu sperren.
Diese plug in übersetzt nicht HTML konforme Zeichen in ihre Entsprechung. Es können eigene Übersetzungen angelegt werden.
Dazu wird eine externe Datei bereitgestellt. Diese Datei ist eine CSV Datei mit folgendem Format:
"Zeichen","HTML"
Beispiel:
"©","©"
"ü","ü"
Bitte beachten, daß die Zeichen & und " nicht aufgenommen werden, diese werden gesondert behandelt.
In den plug werden verschiedene Quelldateien genutzt (Einstellungen, Seite "Dateien"). Die Pfade zu diesen Dateien können absolut oder relativ sein. Relative Pfade werden in folgender Reihenfolge aufgelöst:
Es ist nicht empfehlenswert, Kommentare im "Prefix" Stiel zu verwenden, dies kann zu unvorhersebaren Efekten führen.
Es wird nicht empfohlen, Zeilen mit Prefix innerhalb von tags oder umgekehrt zu nutzen. Dies kann zu unerwarteten Ergebnissen führen.
Element | Standard | Bemerkung | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Dokumentation | <pdm> </pdm> |
Dies ist nicht Teil des plug ins.
Dies wir in Methoden und Prozeduren genutzt, um Abschnitte für die Nutzung in PDM plug-ins zu markieren.
Daten in der Quelldatei benötigen dies nicht! Diese ist die "Hülle" für alle anderen Abschnitte. In der Prefixversion beginnt mit der Abschnitt mit "<pdm>" und endet mit "</pdm>". Es existiert keine tag Version. |
||||||||||||
Beschreibung | descr | Kurze Beschreibung, nutzt die CSS Klasse "*_AB_PDM_Descr" | ||||||||||||
Bemerkungen | remarks |
Erweiterte Bemerkungen. Der Text wird in der "*PDM_AB_Body" CSS Klasse innerhalb der "*PDM_AB_Remarks" CSS Klasse angezeigt. |
||||||||||||
Änderungen | change |
Änderungsverfolgung. tag Syntax:
Die Verwendung wird über eine Option des plug in gesteuert. Die Anzeige der Änderung kann als Besonderheit Änderungen aus dem Quellcode anzeigen, auch wenn die anderen Informationen aus der Quelltabelle gewonnen werden. |
||||||||||||
Beispiel | example |
Formatierbares Beispiel für die Prozedur / Methode. Der Text wird in der "*PDM_AB_Body" CSS Klasse innerhalb der "*PDM_AB_Example" CSS Klasse angezeigt. |
||||||||||||
Siehe auch | seealso |
Formatierbare Liste von Verweisen für auf Prozeduren / Methoden / Klassen oder Dateien. Syntax: Es wird ein Link je Siehe tag angezeigt. Jeder Siehe auch tag erzeugt einen neuen Block. Aller anderer Inhalt im Siehe auch tag wird ignoriert. |
||||||||||||
Warenzeichen | copyright |
Formatierbares Warenzeichen. Der Text wird in der "*PDM_AB_Body" CSS Klasse innerhalb der "*PDM_AB_CopyRight" CSS Klasse angezeigt. |
||||||||||||
Fußbereich | footer |
Ein am Ende des Abschnittes einzufügender Abschnitt. Der Text wird in der "*PDM_AB_Body" CSS Klasse innerhalb der "*PDM_AB_Footer" CSS Klasse angezeigt. |
||||||||||||
Nutzung der Links | appliesto |
Erzeugt automatisch eine Liste der seealso oder see tags welche auf diese Methode zeigen.
In der "prefix" Version nicht verfügbar: tag Syntax:
Es wird das erste tag ausgewertet. |
||||||||||||
Link | pdmlink |
Zeigt an, das ein anderer Record in der Quelltabelle genutzt wird.
Dies ist bei sich wiederholenden Methoden sinnvoll. In der "prefix" Version nicht verfügbar: tag Syntax:
Um Links zu nutzen, muß eine Quelldatei angegeben sein. Nicht angegebene Attribute werden mit den Werten des aktuell bearbeiteten "Objektes" belegt. Angegebene aber leere Attribute werden nicht ersetzt. Es muß jedoch mindestens ein Parameter angegeben werden. Beispiel: Link für die Methode Init der Klasse myForm in der Bibliothek sample.vcx: |
||||||||||||
Die Elemente unterhalb dieser Zeile können in den Elementen oberhalb dieser Zeile genutzt werden. |
||||||||||||||
Code | code |
Dieser tag enthält einen Textblock der als VFP Quellcode angezeigt wird. Achtung, dieser Text kommt in <pre> tags. Alle führenden Leerzeichen und Tabs werden angezeigt! |
||||||||||||
Ausdruck | expr | Dieser tag enthält Text der ohne Umbruch als VFP Quellcode angezeigt wird. | ||||||||||||
Unformatiert | plain |
Dieser tag enthält einen Textblock 1:1 dargestellt wird. Alle Nicht-HTML-Zeichen werden übersetzt, Zeilenumbrüche beibehalten. |
||||||||||||
xhtml | xhtml |
Dieser tag enthält einen Textblock der frei HTML formatiert werden kann. Dieser tag wird ignoriert, wenn die "Nur-XHTML" Option des plug ins aktiviert ist. |
||||||||||||
Siehe | see |
Dieser tag enthält einen eingebetteten Verweis auf eine anderes Quellcodeelement.
|
||||||||||||
Notiz | note |
Erzeugt einen Block "Notiz".
Dieser Block kann ein einleitendes Bild und spezielle Formatierung erhalten.
Die Blöcke können frei über eine CSV Datei definiert werden. tag Syntax:
Dazu wird eine externe Datei bereitgestellt. Diese Datei ist ein CSV Datei mit folgendem Format: "ID","CSS Class","Picture","Title of picture" Beispiel: "E","_PDM_AB_nExclamation","_diamp\res\excla.gif","" "I","_PDM_AB_nInformation","_diamp\res\info.gif","Dies ist eine Information" Die Bilder sind relativ zum Speicherort des Plug ins |
||||||||||||
Automatisches Datum | autodate |
Dieser tag wird durch das Datum des Zeitstempels tTimeStamp der Quelldatei
oder wenn kein Datensatz existiert, das Feld nicht existiert oder das Feld leer,
ist mit dem aktuellen Datum ersetzt.
|
||||||||||||
Selbstreferenz | self |
Dieser tag fügt eine Beschreibung des momentan beschriebenen Items ein.
PEM > Klasse > Datei Form: Datei:: Klasse[.Objekt]n.PEM |
Aller anderer Text welcher nicht Teile einer Zeile mit Prefix ist oder sich nicht innerhalb eines Tages befindet, wird am Ende der Prozedur mit der CSS Klasse "PDM_AB_Other" dargestellt.
*!* <pdm> *!* DESCR This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0 *!* DESCR The function will be disabled in Version 7 and beyond using #IF *!* Example <code> *!* Example TEXT lcText NOSHOW *!* Example <short>Specify the type of controls <i>placed<i> on the search.</short> *!* Example ENDTEXT *!* Example lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* Example </code> *!* PARAMS tcSearchExpression ByVal IN Character Specifies the string to search. *!* </pdm> |
*!* <pdm> *!* <descr> *!* This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0 *!* The function will be disabled in Version 7 and beyond using #IF *!* </descr> *!* <example><code> *!* TEXT lcText NOSHOW *!* <short>Specify the type of controls <i>placed<i> on the search.</short> *!* ENDTEXT *!* lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* </code> *!* </example> *!* <params name="tcSearchExpression" direction="IN" type="Character"> *!* <short>Specifies the string to search.</short> *!* </params> *!* </pdm> |
*!* <pdm> *!* <descr> *!* This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0</descr> *!* DESCR The function will be disabled in Version 7 and beyond using #IF *!* <example><code> *!* TEXT lcText NOSHOW *!* <short>Specify the type of controls <i>placed<i> on the search.</short> *!* ENDTEXT *!* lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* </code></example> *!* PARAMS tcSearchExpression ByVal IN Character Specifies the string to search. *!* </pdm> |