Buscar..


Introducción

Scribble es la herramienta utilizada para crear la documentación de Racket , ¡y también puedes documentar tus propios paquetes! Cuando se publique, su documentación aparecerá en https://docs.racket-lang.org/ , junto con la documentación principal de Racket.

Scribble se implementa como un lenguaje para la plataforma Racket. Por lo tanto, los documentos de Scribble generalmente comienzan con #lang scribble/manual

Párrafos y secciones

#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.

Documentando un enlace proporcionado por un paquete

#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)}}]
}

Como regla de oro, un módulo .scribble debe documentar un módulo (algo que podría aparecer a la derecha de un (require foo/bar) , es decir, foo/bar ). Un archivo .scribble puede documentar varios módulos, siempre que cada uno esté documentado en una @section separada.



Modified text is an extract of the original Stack Overflow Documentation
Licenciado bajo CC BY-SA 3.0
No afiliado a Stack Overflow