fixedpoint.jp - Scheme 処理系のドキュメンテーションツール、特に Scribble の場合




Scheme 処理系のドキュメンテーションツール、特に Scribble の場合

実用的な Scheme 処理系はどれもよい文書を提供しています。それらはシステムとともにインストールされると同時に、Web 上で閲覧できる形で公開されています。

例えば、

また、まだ draft のようですが Ypsilon も独自の API 文書を用意しています: http://www.littlewing.co.jp/ypsilon/doc-draft/index.html

特に、http://lambda-the-ultimate.org/node/4017 でも紹介されている PLT の文書ツール Scribble についての論文に興味深い内容がまとめられています: Scribble: Closing the Book on Ad Hoc Documentation Tools

上にも挙げた PLT の文書はもちろん、この論文自体が Scribble を使って記述されています。

特徴として

という点が紹介されています。技術的には、コードの run-time/compile-time 以外に設けている label-phase-level という段階でコード内の文書を処理することで、自由度を高めているということです。

また結論には、有名な Scheme の設計方針を表す引用をもじって、次のような文章が掲げられています:

A documentation language should be designed not by piling escape conventions on top of a comment syntax, but by removing the weaknesses and restrictions of the programming language that make a separate documentation language appear necessary. Scribble demonstrates that a small number of rules for forming documentation, with no restrictions on how they are composed, suffice to form a practical and efficient documentation language that is flexible enough to support the major documentation paradigms in use today.

ちなみに、この論文では文書の多言語化については触れられていません。

参考


© 2006-2010 Takeshi Abe