खोज…
परिचय
स्क्रिबल एक ऐसा उपकरण है जिसका उपयोग रैकेट के दस्तावेज बनाने के लिए किया जाता है, और आप अपने स्वयं के पैकेज भी इसके साथ दस्तावेज कर सकते हैं! प्रकाशित होने पर, उनका प्रलेखन मुख्य रैकेट प्रलेखन के साथ https://docs.racket-lang.org/ पर दिखाई देगा।
रैकेट प्लेटफॉर्म के लिए एक भाषा के रूप में स्क्रिबल को लागू किया जाता है। स्क्रिबल दस्तावेज़ इसलिए आमतौर पर #lang scribble/manual
साथ शुरू #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