racket
kattebelletje
Zoeken…
Invoering
Scribble is de tool die wordt gebruikt om de documentatie van Racket te maken en u kunt er ook uw eigen pakketten mee documenteren! Na publicatie verschijnt hun documentatie op https://docs.racket-lang.org/ , naast de hoofddocumentatie van het racket.
Scribble is geïmplementeerd als een taal voor het Racket-platform. Scribble-documenten beginnen daarom meestal met #lang scribble/manual
Alinea's en secties
#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.
Documenteren van een binding geleverd door een pakket
#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 vuistregel moet een module (iets dat rechts van een kan verschijnen (require foo/bar)
, dwz foo/bar
) worden gedocumenteerd door een enkel .scribble
bestand. Een .scribble
bestand kan verschillende modules documenteren, zolang elke module in een afzonderlijke @section
is gedocumenteerd.
Modified text is an extract of the original Stack Overflow Documentation
Licentie onder CC BY-SA 3.0
Niet aangesloten bij Stack Overflow