Sök…
Introduktion
Scribble är det verktyg som används för att skapa Rackets dokumentation , och du kan också dokumentera dina egna paket med det! När de publiceras kommer deras dokumentation att visas på https://docs.racket-lang.org/ , tillsammans med den viktigaste Racket-dokumentationen.
Scribble implementeras som ett språk för Racket-plattformen. Skribentdokument börjar därför vanligtvis med #lang scribble/manual
Avsnitt och avsnitt
#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.
Dokumentera en bindning som tillhandahålls av ett paket
#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)}}]
}
Som en tumregel bör en modul (något som kan visas till höger om en (require foo/bar)
, dvs. foo/bar
) dokumenteras av en enda .scribble
fil. En .scribble
fil kan dokumentera flera moduler, så länge var och en är dokumenterad i en separat @section
.
Modified text is an extract of the original Stack Overflow Documentation
Licensierat under CC BY-SA 3.0
Inte anslutet till Stack Overflow