如何使用scribble记录语法？

Question

我想制作一些关于我正在制作的项目的文档，我想使用#lang scribble/manual来制作它。

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

我该怎么办？

谢谢！

Answer 1

您可以使用defproc，defform等Scribble表单来定义这些＆＃34;蓝框＆＃34;文档中的块。

这些表单的相关文档页面都有显示其用途的示例，因此我只是复制文档中的一个示例，这些示例可能会帮助您入门：

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

defproc的文档为here。页面下方还有其他表格的例子。

您可能还需要阅读以下指南来记录球拍库：http://docs.racket-lang.org/scribble/how-to-doc.html