documentation - 如何使用 scribble 记录语法？

Question

我想制作一些关于我正在制作的项目的文档，并且我想使用#lang scribble/manual.

由于我有一些用户定义的程序，我想让我的手册看起来像这样，我的意思是procedure/syntax手册中的蓝色方块。

我怎么能做这样的事情？

谢谢！

Answer 1

defproc您可以使用,等涂鸦形式defform在文档中定义这些“蓝框”块。

这些表单的相关文档页面有显示它们使用的示例，因此我将复制文档中的一个示例，这可能会帮助您入门：

@defproc[(make-sandwich [ingredients (listof ingredient?)])
         sandwich?]{
  Returns a sandwich given the right ingredients.
}

的文档defproc在这里。页面下方有其他表格的示例。

您可能还想阅读以下记录 Racket 库的指南：http: //docs.racket-lang.org/scribble/how-to-doc.html