cxref – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

cxref – C-Querverweis- und Dokumentationstool.

ZUSAMMENFASSUNG

cxref Dateinamen [ ... Dateiname] [-Ödirname] [-NBasisname] [-RBasisname] [-Alle Kommentare]
[-keine Kommentare] [-verbatim-comments] [-block-comments]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-roh] [-Latex] [-html[-src]] [-rtf] [-sgml]
[-ICHdirname] [-Ddefinieren] [-Udefinieren] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref Dateinamen [ ... Dateiname] -löschen [-Ödirname] [-NBasisname] [-RBasisname]

BESCHREIBUNG

Ein Programm, das automatisch Dokumentation und Querverweise für ein C generieren kann


Die Eingabe ist ein beliebiges C-Programm mit entsprechenden Kommentaren und die Ausgabe ist LaTeX, HTML, RTF oder
SGML-Dateien.

OPTIONAL

Dateinamen
Der Name der zu dokumentierenden Datei. Es können beliebig viele Dateien gleichzeitig dokumentiert werden.

-löschen
Die genannten Dateien sollen aus dem Ausgabeverzeichnis und deren Einträge in gelöscht werden
Die Querverweisdatenbank und die Hauptausgabedateien müssen entfernt werden.

-Odirname
Der Name eines Verzeichnisses, das für die Ausgabe-Latexdateien verwendet werden soll, und der Speicherort davon
Querverweisdateien, die erstellt werden.

-Nbasename
Der Name, der stattdessen für den ersten Teil der Ausgabe- und Querverweisdateien verwendet werden soll
von cxref bleiben die Dateierweiterungen gleich.

-Rdirname
Wenn sich die Quelldateien in mehr als einem Verzeichnis befinden, setzen Sie dirname auf den Namen von
das Stammverzeichnis des Quellbaums (verwenden Sie einen relativen Pfad, wenn dies einfacher ist, z. B. „-R.“)./ ..').
Dadurch wird dann cxref aus diesem Stammverzeichnis ausgeführt und der „-Odirname“ muss vorhanden sein
relativ zu diesem Verzeichnis.

-Alle Kommentare
Falls Sie der Meinung sind, dass die vorhandenen Kommentare funktionieren könnten (Beschreibung siehe oben).
von Sonderkommentaren). [Gefahr! Diese Option kann zu seltsamen Ergebnissen führen.]

-keine Kommentare
Ignoriert alle Kommentare. Dies ist nützlich, wenn Sie nur die Querverweise und nicht die Kommentare möchten
Dokumentation.

-wörtliche Kommentare
Wenn die Kommentare, die Sie im Code haben, in einem vorgegebenen Stil formatiert sind
die Sie in der Ausgabe beibehalten möchten, erzwingt diese Option, dass dies nicht der Fall ist
neu formatiert. [Hinweis: Dies gilt nur für Datei- und Funktionskommentare.]

-Block-Kommentare
Wenn die Kommentare im Programm im „Block“-Stil (mit einem führenden Kommentar) formatiert sind
Geben Sie in jeder Zeile das Zeichen „*“ ein. Diese Option entfernt dieses Zeichen aus der
Ausgabe. [Funktioniert für ein einzelnes „*“, „+“, „|“ oder „:“ in jeder Zeile.]

-xref Erstellen Sie Querverweise (siehe unten).
-all Alle Querverweise.
-file Querverweise für Dateien.
-func Querverweise für Funktionen.
-var Querverweise für Variablen.
-type Querverweise für Typen.

-warnen Warnungen erzeugen, die Optionen müssen miteinander verkettet werden:
-all Alle Warnungen.
-comment Warnung vor fehlenden Kommentaren.
-xref Warnt vor fehlenden Querverweisen.

-Index Erstellen Sie einen Querverweisindex. Die Optionen müssen miteinander verkettet werden:
-all Alle Indizes.
-file Index der Dateien.
-func Index der Funktionen.
-var Index der Variablen.
-type Index der Typen.

-roh Erzeugt eine Rohausgabe, die außer mit -warn nicht wirklich von großem Nutzen ist.

-Latex Erstellen Sie eine LaTeX-Datei, um jede der Quelldateien sowie eine zusätzliche Datei zu dokumentieren
das jede dieser Dateien enthält.

-html Erstellen Sie eine HTML 4.01-Datei, um jede der Quelldateien und eine Hauptdatei zu dokumentieren
Verweisen Sie auf jede dieser Dateien.

-html-src
Erstellen Sie die HTML-Ausgabe und eine HTML-Version der Quelldatei mit Links dazu.

-rtf Erstellen Sie eine RTF-Datei (Rich Text Format), um die Quelldatei zu dokumentieren.

-sgml Erstellen Sie eine SGML-Datei zur Dokumentation der Quelldatei. (Verwenden der LinuxDoc-DTD).

-Idirname
GCC-Option zur Angabe des Pfads für Include-Dateien.

-Ddefinieren
GCC-Option zum Definieren eines Präprozessorsymbols.

-Udefine
GCC-Option zum Aufheben der Definition eines Präprozessorsymbols.

-CPP Programm
Der Name des Programms, das anstelle des Standardwerts für die Kompilierungszeit verwendet werden soll. Das Programm
Damit es funktioniert, muss es in der Lage sein, alle Aktionen auszuführen, die „gcc -E -C -dD“ ausführt. Wenn
Das Programm akzeptiert Argumente, dann muss das Ganze in Anführungszeichen stehen, damit es funktioniert
wird als einzelnes Argument für cxref interpretiert.

--arg ... arg
Zusätzliche Argumente, die an den Präprozessor übergeben werden sollen, können nach dem „--“ platziert werden.
Separator.

C Compiler Ersatz cxref-cc
Um die Verwendung von cxref für vorhandenen Quellcode zu vereinfachen, gibt es jetzt ein Shell-Skript, das dies ermöglicht
Rufen Sie den C-Compiler auf und rufen Sie dann cxref auf, um die Quelldatei zu verarbeiten. Das bedeutet, dass es
kann als Ersatz für CC in Makefiles und dergleichen verwendet werden.

Verwendung: cxref-cc [übliche CC-Optionen]

Der Name der Quelldatei wird aus der Liste der Optionen extrahiert, ebenso wie das „-D*“,
Die Flags „-I*“, „-U*“ und wenn der C-Compiler erfolgreich beendet wird, wird cxref aufgerufen. Der
Der Name des zu verwendenden C-Compilers wird durch die Umgebungsvariable CXREFCC gesteuert, oder wenn
Dies ist dann nicht die CC-Umgebungsvariable oder, falls dies fehlschlägt, nur gcc.

Die Verwendung dieses Skripts erfordert die Verwendung einer „.cxref“-Konfigurationsdatei, um die Optionen zu enthalten
da es für den C-Compiler keine Möglichkeit gibt, die Optionen in die Befehlszeile einzufügen.

Dadurch werden nur die C-Quelldateien referenziert und dokumentiert, da sie die einzigen sind
diejenigen, die kompiliert werden, aber es stellt sicher, dass sie mit den Querverweisen versehen sind
richtige Optionen usw.

Cxref Konfiguration Reichen Sie das
Diese Befehlszeilenargumente können statt in der Datei auch in eine Datei mit dem Namen „.cxref“ eingefügt werden
Befehlszeile. Wenn cxref ausgeführt wird, werden die Argumente des Programms im interpretiert
folgender Reihenfolge.

(1) Die in der Befehlszeile. (2) Die in der „.cxref“-Datei im aktuellen Verzeichnis.
(3) Die in der „.cxref“-Datei in der durch „-R“ angegebenen Quellbaumwurzel.

Das bedeutet, dass in einem Quellbaum mit mehreren Verzeichnissen jedes Unterverzeichnis eine „.cxref“-Datei haben kann.
Datei, die nur die Zeile „-R..“ oder entsprechendes enthält. Das Hauptverzeichnis kann eine haben
„.cxref“-Datei, die die restlichen Optionen enthält. Dadurch entfällt die Notwendigkeit vollständig
um außer den Quelldateinamen alle Optionen in der Befehlszeile zu haben.

Das Format der „.cxref“-Datei besteht aus einer beliebigen Anzahl von Zeilen, von denen jede eine einzelne enthält
Befehlszeilenargument (entspricht einem der argv). Die einzigen Optionen, die es nicht geben kann
Verwendet werden die Namen der Quelldateien selbst und die Option „-delete“. Leerzeilen sind
ignoriert und Zeilen, die mit einem „#“ beginnen, sind Kommentare.

Programm Dokumentation Ihre Nachricht
Die Dokumentation für das Programm wird aus Kommentaren im Code erstellt
entsprechend formatiert. Die Querverweise stammen aus dem Code selbst und erfordern keine
Extra Arbeit.

Die speziellen Kommentare sind „/**** ****/“ (für eine Datei) und „/**+++ ++++*/“ (für Daten).
Objekt) Innerhalb des Standardkommentars „/*“ und „*/“ kann eine beliebige Anzahl von „*“ oder „+“ verwendet werden
Trennzeichen in den Kommentaren werden ignoriert.

Wenn eine Kommentarzeile mit einem Leerzeichen beginnt und von „+html+“ gefolgt wird, gilt der Rest
Die Zeile ist nur in der HTML-Ausgabe enthalten und wird nicht verarbeitet, sodass sie HTML enthalten kann
Markup, „-html-“ bedeutet, dass der Rest der Zeile in allen außer dem HTML enthalten ist
Ausgabe. Gleiches gilt auch für die anderen Ausgabeformate, für Zeilen kann „+none+“ verwendet werden
in keiner Ausgabe erscheinen. Die Ausnahme hiervon ist, dass die Rohausgabe keine Funktion hat
überprüft und gibt alle Zeilen aus.

In jeder Situation, in der ein Kommentar auf ein „,“, „;“ folgt oder „)“ nur durch Leerzeichen und getrennt
Bei Tabulatoren wird der Kommentar vor das Satzzeichen verschoben, um dort auf das Objekt angewendet zu werden.

Das Programm wird mithilfe eines vollständigen ANSI-C-Grammatikparsers mit einigen GCC-Erweiterungen implementiert.
Das bedeutet, dass der Stil des Codes keine Rolle spielt, sondern nur der Inhalt und die Kommentare.

Cross Referenzieren
Die Querverweise werden für die folgenden Elemente durchgeführt

Mappen
Die Dateien, in denen die aktuelle Datei enthalten ist
(auch wenn über andere Dateien eingebunden).

#enthält
In der aktuellen Datei enthaltene Dateien.
In diesen Dateien enthaltene Dateien usw.

Variablen
Der Ort der Definition externer Variablen.
Die Dateien, in denen globale Variablen sichtbar sind.
Die Dateien/Funktionen, die die Variable verwenden.

Funktionen
Die Datei, in der die Funktion als Prototyp erstellt wird.
Die Funktionen, die die Funktion aufruft.
Die Funktionen, die die Funktion aufrufen.
Die Dateien und Funktionen, die auf die Funktion verweisen.
Die Variablen, die in der Funktion verwendet werden.

Auf jedes dieser Elemente wird in der Ausgabe verwiesen.

Die Querverweise verwenden die Dateien „cxref.variable“, „cxref.function“, „cxref.include“ und
„cxref.typedef“ im Ausgabeverzeichnis. Dies ist eine vollständige Liste der Funktionen und
Variablenverwendung im Programm und könnte zum Generieren einer Funktionsaufrufhierarchie oder verwendet werden
Beispiel: Variablennutzungsdiagramm. Für jede Datei sind zwei cxref-Durchgänge erforderlich, der erste bis
Erstellen Sie die Querverweisdateien und verwenden Sie sie als Zweites.

(Die Dateinamen sind unterschiedlich, wenn die Option „-N“ verwendet wird.)

Latex Output
Die standardmäßige LaTeX-Ausgabe ist eine Datei für jede der Quelldateien mit einer zusätzlichen Datei
„cxref.tex“, das alle anderen Dateien enthält. Dies dient nur dazu, ein Makefile zuzulassen
Aktualisieren Sie die geänderten Dateien (obwohl die Referenzen möglicherweise erfordern, dass alle Dateien aktualisiert werden).
noch einmal überprüft). Wenn die cxref.tex-Datei geschrieben wurde, kann sie vom Benutzer geändert werden.
Alle neu hinzugefügten Dateien werden am Ende des Quellcodeabschnitts hinzugefügt, der Rest davon
Die Datei bleibt unverändert.

Der Index wird in eine Datei namens „cxref.apdx.tex“ geschrieben und cxref.tex wird aktualisiert, um darauf zu verweisen
verbunden.

Ebenfalls ausgeschrieben sind drei LaTeX-Stildateien „page.sty“, „fonts.sty“ und „cxref.sty“.
Dadurch wird die Seite so eingerichtet, dass ein kleinerer Rand und kleinere Schriftarten verwendet werden, damit mehr angezeigt wird
Erstellen Sie eine Seite und definieren Sie außerdem die neuen Befehle zum Setzen der cxref-Ausgabe.

(Die Dateinamen „cxref.tex“ und „cxref.apdx.tex“ sind unterschiedlich, wenn die Option „-N“ aktiviert ist
Gebraucht.)

HTML Output
Die Standard-HTML-Ausgabe ist eine Datei für jede der Quelldateien mit einer zusätzlichen Datei
„cxref.html“, das alle anderen Dateien enthält. Dies dient nur dazu, ein Makefile zuzulassen
Aktualisieren Sie die geänderten Dateien (obwohl die Referenzen möglicherweise erfordern, dass alle Dateien aktualisiert werden).
noch einmal überprüft). Wenn die Datei cxref.html geschrieben wurde, kann sie vom Benutzer geändert werden.
Alle neu hinzugefügten Dateien werden am Ende vor dem Inhaltsverzeichnis hinzugefügt, der Rest
dass die Datei unverändert bleibt.

Der Index wird in eine Datei namens „cxref.apdx.html“ geschrieben und cxref.html wird aktualisiert, um darauf zu verweisen
verbunden.

(Die Dateinamen „cxref.html“ und „cxref.apdx.html“ sind unterschiedlich, wenn die Option „-N“ aktiviert ist
Gebraucht.)

Die HTML-Ausgabe verwendet den HTML 4.01-Standard und alle Seiten werden korrekt validiert.

RTF Output
Das Rich Text Format ist ein relativ einfaches Seitenbeschreibungsformat, das von Microsoft entwickelt wurde. Es
ist kein klar definierter und leicht verständlicher Standard wie die anderen Formate, aber er ist es
beliebt für den Dokumentenaustausch.

Für jede der Quelldateien gibt es eine einzige Ausgabedatei und eine Indexdatei.

SGML Output
Da SGML eine Metasprache ist, ist es notwendig, auch die Layoutelemente zu definieren
die Informationen bereitstellen. Die cxref-Ausgabe verwendet das LinuxDoc-Dokumentformat und ist
Entwickelt für die Verwendung mit den SGMLtools-Programmen (http://www.sgmltools.org/).

Für jede der Quelldateien gibt es eine einzige Ausgabedatei und eine Indexdatei.

Verwenden Sie cxref online über die Dienste von onworks.net