如何使用 scribble 记录语法？答案

【问题标题】：How to document syntax using scribble?如何使用 scribble 记录语法？
【发布时间】：2014-12-11 01:24:49
【问题描述】：

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

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

我怎么能做这样的事情？

谢谢！

【问题讨论】：

【解决方案1】：

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

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

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

defproc 的文档是 here。页面下方还有其他表单的示例。

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

【讨论】：

这行得通，但是我在 listof 下得到了一条红线，我应该在其中有一个指向球拍文档的链接。我想我又错过了一些东西，但我不知道是什么。球拍的这个文档文档非常混乱！ !
您可能在某处遗漏了(require (for-label <module>))。要么，要么您需要向scribble 提供交叉引用参数。请参阅this page（尝试+m 标志）。如果您将文档设置为为您的包自动构建，则不必指定交叉引用信息（我链接的指南描述了如何执行此操作）。
谢谢，我运行了scribble --htmls ++main-xref-in <file.scrbl>，它成功了。