수색…


소개

Scribble은 Racket의 문서 를 만드는 데 사용되는 도구이며, 자신 만의 패키지도 함께 문서화 할 수 있습니다! 출판 될 때, 그들의 문서는 Racket 주요 문서와 함께 https://docs.racket-lang.org/에 나타날 것입니다.

Scribble은 Racket 플랫폼 용 언어로 구현됩니다. 낙서 문서는 대개 #lang scribble/manual 으로 시작합니다.

단락 및 섹션

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

패키지가 제공하는 바인딩 문서화

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

경험적으로, 모듈 ( (require foo/bar) 의 오른쪽에 나타날 수있는 모듈, 즉 foo/bar 는 단일 .scribble 파일로 문서화되어야합니다. .scribble 파일은 각 모듈이 별도의 @section 문서화되어있는 한 여러 모듈을 문서화 할 수 있습니다.



Modified text is an extract of the original Stack Overflow Documentation
아래 라이선스 CC BY-SA 3.0
와 제휴하지 않음 Stack Overflow