如何使用塗鴉文檔語法？

我想製作一些關於我正在製作的項目的文檔，並且我想使用#lang scribble/manual。如何使用塗鴉文檔語法？

由於我有一些用戶定義的過程，我想使我的手冊看起來像this，我的意思是手冊中的藍色procedure/syntax平方。

我該怎麼做這樣的事情？

謝謝！

2014-12-11 David Merinos

您可以使用Scribble格式如defproc,defform等來在文檔中定義這些「藍色方塊」塊。

對於這些形式的相關文檔頁面有例子，說明它們的使用，所以我就複製，從中可以幫助文檔你開始一個例子：

@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

來源

2014-12-11 02:03:56

這工作，但我得到下listof一條紅線，我應該已經鏈接到球拍的文檔。我想我又錯過了一些東西，但我不知道是什麼。這種球拍文件記錄非常混亂！！ – 2014-12-11 02:14:03

您可能在某處丟失了'（需要（對於標籤））'。無論是那個，還是你需要提供交叉引用參數給'scribble'。請參閱[本頁]（http://docs.racket-lang.org/scribble/running.html#%28part._xref-flags%29）（嘗試使用'+ m'標誌）。如果您爲包裝設置了自動生成的文檔，則不必指定交叉引用信息（我鏈接的指南介紹瞭如何執行此操作）。 – 2014-12-11 03:33:30

謝謝你，我跑了'塗鴉--htmls ++ main-xref-in '並且它工作。 – 2014-12-11 21:23:47

如何使用塗鴉文檔語法？

回答

相關問題