Freigeben über

Anpassen des Dokumentierungs-Assistenten

  • Artikel

Zusätzlich zu den bei der Ausführung des Dokumentierungs-Assistenten wählbaren Optionen können Sie außerhalb des Assistenten zusätzliche Optionen anpassen.

Einrückung in CASE-Strukturen

Standardmäßig sieht die Einrückung des Assistenten für CASE-Strukturen folgendermaßen aus:

DO CASE
CASE case1=1
   case2=2
CASE case3=3
   case4=4
ENDCASE

Manche Entwickler ziehen es jedoch vor, die Zeilen zwischen DO CASE und ENDCASE wie folgt noch um eine weitere Ebene einzurücken:

DO CASE
   CASE case1=1
      case2=2
   CASE case3=3
      case4=4
ENDCASE

Wenn Sie Ihre CASE-Strukturen wie im zweiten Beispiel einrücken, können Sie dies in Fdkeywrd.dbf angeben. Um diesen Codierungsstil in Fdkeywrd.dbf zu spezifizieren, ändern Sie den Wert des Feldes Code für den ENDCASE-Datensatz nach "UU".

Assistentendirektiven

Sie können in Ihren Codedateien spezielle Direktiven verwenden, die den Dokumentierungs-Assistenten anweisen, bei der Analyse des Codes bestimmte Aufgaben durchzuführen.

Sie können in den folgenden Dateien Direktiven platzieren:

  • Hauptprogrammdatei Ihrer Anwendung; hier können Sie den Assistenten anweisen, wie er alle Codedateien des Projekts zu analysieren hat.
  • Individuelle Codedateien; hier können Sie den Assistenten anweisen, wie er bestimmte Dateien zu analysieren hat.

Die Syntax aller Direktiven beginnt mit einem Stern, so dass Visual FoxPro diese als Kommentare behandelt und bei der Kompilation von Programmen ignoriert. Groß-/Kleinschreibung wird bei den Direktiven nicht berücksichtigt. Direktiven verwenden die folgende Syntax:

*# document directive

Es empfiehlt sich, Direktiven zu Beginn der Hauptprogrammdatei zu platzieren, damit der Dokumentierungs-Assistent zu Beginn der Analyse auf diese stößt.

Im Folgenden finden Sie eine Beschreibung der Direktiven des Dokumentierungs-Assistenten.

  • *# document ACTIONCHARS "abcdef"
    Standardmäßig verwendet der Assistent bei der Erstellung von Aktionsdiagrammen und Strukturdiagrammen sechs Zeichen, die bei Betrachtung in FoxFont unter der ASCII-Codepage 1250 oder unter der ANSI-Codepage 1252 als Linien und Ecken angezeigt werden. Werden diese Zeichen unter anderen Codepages angezeigt, so werden nicht alle dieser Zeichen auf Linienzeichen abgebildet. Im Folgenden finden Sie die sechs Standardzeichen und die entsprechenden FoxFont-Zeichen als a, b, c, d, e und f.
    abcdef Standard-Chr( )-Wert Darstellung in FoxFont
    a 32 (Leerzeichen)
    b 196
    c 179
    D 218
    e 192
    f 195

Tipp   Wenn Sie andere Codepages verwenden, fügen Sie den folgenden Code in Ihre Hauptprogrammdatei ein, um sicherzustellen, dass die Linien in Ihren Diagrammen durch Linien oder linienähnliche Zeichen dargestellt werden (das erste Zeichen der Zeichenfolge in Anführungszeichen ist ein Leerzeichen):

*# document ACTIONCHARS " -|+++"

Anmerkung   Eine Liste der unterstützten Codepages finden Sie unter Von Visual FoxPro unterstützte Codepages.

  • *# document XREF cMode
    Aktiviert die Erstellung von Variablen-Querverweisen. Der Standardwert ist ON.

    cMode Beschreibung
    ON Aktiviert die Erstellung von Variablen-Querverweisen
    OFF Deaktiviert die Erstellung von Variablen-Querverweisen
    SUSPEND Deaktiviert die Erstellung von Variablen-Querverweisen in der aktuellen Datei, bis der Dokumentierungs-Assistent auf das nächste Auftreten der folgenden Direktive stößt:

    *# document XREF ON

  • *# document EXPANDKEYWORDS cMode
    Aktiviert die Erweiterung von Schlüsselwörtern. So wird beispielsweise "DEFI WIND" zu "DEFINE WINDOW" erweitert. Der Standardwert ist OFF.

    Vorsicht   Nicht alle Schlüsselwörter in Visual FoxPro beginnen mit einer eindeutigen, vier Zeichen umfassenden Zeichenfolge. So kann beispielsweise "REPL" gleichermaßen "REPLACE" oder "REPLICATE" bedeuten. Seien Sie vorsichtig, wenn Sie diese Direktive verwenden und vorhandene Dateien überschreiben.

    cMode Beschreibung
    ON Aktiviert die Erweiterung von Schlüsselwörtern
    OFF Deaktiviert die Erweiterung von Schlüsselwörtern
    SUSPEND Deaktiviert die Erweiterung von Schlüsselwörtern in der aktuellen Datei, bis der Dokumentierungs-Assistent auf das nächste Auftreten der folgenden Direktive stößt:

    *# document EXPANDKEYWORDS ON

  • *# document XREFKEYWORDS cMode
    Diese Direktive entspricht der Option Schlüsselwort-Querverweise in "Schritt 6 – Fertigstellen" des Dokumentierungs-Assistenten. Der Standardwert ist OFF.

    cMode Beschreibung
    ON Aktiviert die Erstellung von Schlüsselwort-Querverweisen
    OFF Deaktiviert die Erstellung von Schlüsselwort-Querverweisen
    SUSPEND Deaktiviert die Erstellung von Schlüsselwort-Querverweisen in der aktuellen Datei, bis der Dokumentierungs-Assistent auf das nächste Auftreten der folgenden Direktive stößt:

    *# document XREFKEYWORDS ON

  • *# document ARRAYBRACKETS cMode
    Der Standardwert ist OFF.

    cMode Beschreibung
    ON Der Dokumentierungs-Assistent geht davon aus, dass eckige Klammern für Arrays und runde Klammern für Funktionen und Methoden verwendet werden.
    OFF Der Dokumentierungs-Assistent behandelt sowohl runde als auch eckige Klammern als Arrays.

  • *# document ACTIONINDENTLENGTH nSpace
    nSpace ist die Anzahl der Leerzeichen, die der Dokumentierungs-Assistent für die Einrückung verwenden soll. Der kleinste zulässige Wert ist 2.

Siehe auch

Dokumentierungs-Assistent | Assistenten |Von Visual FoxPro unterstützte Codepages | Dokumentierungs-Assistent: Schritt 1 - Auswählen der Quelldatei | Dokumentierungs-Assistent: Schritt 2 - Festlegen der Groß-/Kleinschreibung | Dokumentierungs-Assistent: Schritt 3 - Festlegen der Einrückung | Dokumentierungs-Assistent: Schritt 4 - Hinzufügen von Überschriften | Dokumentierungs-Assistent: Schritt 5 - Auswählen von Berichten | Dokumentierungs-Assistent: Schritt 6 - Fertigstellen