Szukaj…
Wprowadzenie
Scribble to narzędzie służące do tworzenia dokumentacji rakiet , dzięki czemu możesz również dokumentować własne paczki! Po opublikowaniu ich dokumentacja pojawi się na stronie https://docs.racket-lang.org/ wraz z główną dokumentacją dotyczącą rakiety.
Scribble jest zaimplementowany jako język dla platformy Racket. Dokumenty #lang scribble/manual
zwykle zaczynają się od #lang scribble/manual
Akapity i sekcje
#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.
Dokumentowanie powiązania dostarczonego przez paczkę
#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)}}]
}
Zasadniczo moduł (coś, co może pojawić się po prawej stronie (require foo/bar)
, tj. foo/bar
) powinien być udokumentowany pojedynczym plikiem .scribble
. Plik .scribble
może dokumentować kilka modułów, o ile każdy z nich jest udokumentowany w osobnej @section
.
Modified text is an extract of the original Stack Overflow Documentation
Licencjonowany na podstawie CC BY-SA 3.0
Nie związany z Stack Overflow