Suche…


Einführung

Scribble ist das Werkzeug, mit dem die Dokumentation von Racket erstellt wird , und Sie können damit auch Ihre eigenen Pakete dokumentieren! Nach der Veröffentlichung erscheint ihre Dokumentation neben https://docs.racket-lang.org/ neben der Hauptdokumentation zum Racket.

Scribble ist als Sprache für die Racket-Plattform implementiert. Scribble-Dokumente beginnen daher normalerweise mit #lang scribble/manual

Absätze und Abschnitte

#lang scribble/manual

@section{Introduction}

First paragraph. Some text, some text, some text,
some text, some text, some text.

@section{More stuff}

@subsection{This is a subsection}

Second paragraph. More text, more text, more text,
more text, more text, more text.

Dokumentieren einer Bindung, die von einem Paket bereitgestellt wird

#lang scribble/manual

@; Make sure that code highlighting recognises identifiers from my-package:
꩜require[@for-label[my-package]]

@; Indicate which module is exporting the identifiers documented here.
@defmodule[my-package]

@defproc[(my-procedure [arg1 number?] [arg2 string?]) symbol?]{
  The @racket[my-procedure] function repeats the @racket[arg2] string
  @racket[arg1] times, and transforms the result into a symbol.

  @history[#:added "1.0"
           #:changed "1.1" @elem{Improved performance,
                                 from @tt{O(n²)} to @tt{O(n)}}]
}

Als Faustregel gilt, dass ein Modul (etwas, das auf der rechten Seite erscheinen kann (require foo/bar) , dh foo/bar ) in einer einzigen .scribble Datei dokumentiert werden sollte. Eine .scribble Datei kann mehrere Module dokumentieren, sofern jedes in einem separaten @section .



Modified text is an extract of the original Stack Overflow Documentation
Lizenziert unter CC BY-SA 3.0
Nicht angeschlossen an Stack Overflow