Dies ist der Befehl scaladoc, der beim kostenlosen Hosting-Anbieter OnWorks mit einer unserer zahlreichen kostenlosen Online-Workstations wie Ubuntu Online, Fedora Online, dem Windows-Online-Emulator oder dem MAC OS-Online-Emulator ausgeführt werden kann
PROGRAMM:
NAME/FUNKTION
scaladoc - Dokumentationsgenerator für die Sprache Scala 2
ZUSAMMENFASSUNG
scaladoc [Optionen> ]Quelle Dateien>
PARAMETER
<Optionen>
Befehlszeilenoptionen. Sehen OPTIONAL unten mit.
<Quelle Dateien>
Eine oder mehrere zu kompilierende Quelldateien (z. B. MyClass.scala).
BESCHREIBUNG
Die scaladoc Das Tool liest Klassen- und Objektdefinitionen, die in der Scala 2-Programmierung geschrieben wurden
Sprache und generiert ihre API als HTML-Dateien.
Standardmäßig legt der Generator jede HTML-Datei im selben Verzeichnis wie ihre Quelldatei ab.
Sie können mit ein separates Zielverzeichnis angeben -d (sehen OPTIONAL, unter).
Das anerkannte Format von Kommentaren in der Quelle wird in der Online-Dokumentation beschrieben
OPTIONAL
Standard Optionen
-d <Verzeichnis>
Geben Sie an, wo die Dokumentation generiert werden soll.
-Ausführung
Produktversion drucken und beenden.
-Hilfe Drucken Sie eine Zusammenfassung der verfügbaren Optionen aus.
Dokumentation Optionen
-doc-Titel <Titel>
Definieren Sie den Gesamttitel der Dokumentation, normalerweise den Namen der Bibliothek
dokumentiert wird.
-doc-version <Version>
Definieren Sie die Gesamtversionsnummer der Dokumentation, normalerweise die Version von
Die Bibliothek wird dokumentiert.
-doc-source-url <URL>
Definieren Sie eine URL, die mit Quellspeicherorten für Links zu Quelldateien verkettet werden soll.
-doc-externes-doc <externes-doc>
Definieren Sie eine durch Kommas getrennte Liste von classpath_entry_path#doc_URL-Paaren, die beschreiben
externe Abhängigkeiten.
Compiler Optionen
-verbose
Gibt Meldungen darüber aus, was der Compiler tut
-Missbilligung
Geben Sie an, ob die Quelle mit veralteten Informationen kompiliert werden soll. Standardwerte
auf aus (akzeptierte Werte sind: ein, aus, ja und nein)
Verfügbar seit Scala-Version 2.2.1
-Klassenpfad <Weg>
Geben Sie an, wo Benutzerklassendateien zu finden sind (auf Unix-basierten Systemen durch einen Doppelpunkt getrennt).
Pfadliste, auf Windows-basierten Systemen eine durch Semikolons getrennte Pfadliste). Das
überschreibt nicht den integrierten Suchpfad („Boot“).
Der Standardklassenpfad ist das aktuelle Verzeichnis. Festlegen der CLASSPATH-Variablen oder
Die Verwendung der Befehlszeilenoption -classpath überschreibt diese Standardeinstellung, wenn Sie möchten
Um das aktuelle Verzeichnis in den Suchpfad aufzunehmen, müssen Sie „.“ einschließen. im Neuen
zu üben.
-Quellenpfad <Weg>
Geben Sie an, wo Eingabequelldateien zu finden sind.
-bootclasspath <Weg>
Überschreiben Sie den Speicherort der Bootstrap-Klassendateien (wo sich die standardmäßig integrierte Datei befindet).
Klassen wie „scala.List“).
-extdirs <dirs>
Überschreiben Sie den Speicherort installierter Erweiterungen.
-Codierung <Codierung>
Geben Sie die von Quelldateien verwendete Zeichenkodierung an.
Der Standardwert ist plattformspezifisch (Linux: „UTF8“, Windows: „Cp1252“).
Wenn Sie den folgenden Code im Scala-Interpreter ausführen, wird der Standardwert zurückgegeben
auf Ihrem System:
Skala> neuer java.io.InputStreamReader(System.in).getEncoding
EXIT STATUS
scaladoc Gibt einen Null-Exit-Status zurück, wenn die angegebene Eingabe erfolgreich verarbeitet werden konnte
Dateien. Im Fehlerfall wird ein Wert ungleich Null zurückgegeben.
AUTOREN
Diese Version von Scaladoc wurde von Gilles Dubochet mit Beiträgen von Pedro geschrieben
Furlanetto und Johannes Rudolph. Es basiert auf dem ursprünglichen Scaladoc (Sean McDirmid,
Geoffrey Washburn, Vincent Cremet und St?phane Micheloud), über vScaladoc (David Bernard),
sowie auf einer unveröffentlichten Version von Scaladoc 2 (Manohar Jonnalagedda).
Nutzen Sie scaladoc online über die Dienste von onworks.net
