htmlとして表示するとドキュメントとサンプルが動くjsファイルはどうでしょう?

Rubyではライブラリーのコード内に
if __FILE__ == $0のように書いて、
そのライブラリーの使い方やテストのコードを書くことがあるらしい。
http://www.jaist.ac.jp/~m-hatake/design/

PHPでも同じようなことをしようとしている方もいます。
http://blog.bz2.jp/archives/2008/04/post_78.html

JavaScriptでもすれば良いんじゃない、と思ってやってみました。
同じファイルを、htmlとして表示するとドキュメントが表示され、サンプルコードが動いて、
全く同じファイルをJavaScriptとして読み込むとサンプルコード部分は動かずライブラリーとして使える、と言うものです。

htmlとして表示した場合のサンプル
同じファイルをjavascriptとして読み込んだ場合のサンプル

ちなみに、JavaScriptとして読み込むところで、拡張子htmlのファイルを<sciprt src=>で指定してしまっています。
これが気になるなら、拡張子を変えて使えば良いかと思います。

JavaScriptのライブラリーとかはこの状態で配布して、テストコードを省いたものをminified版として配布したら良いんじゃないかと思いました。

イメージとしては、
まずhtmlとして表示してこのライブラリーで何ができるかを知る、
良さそうだったらそのファイルをダウンロードして拡張子を変えて使う、
と言う感じです。

もうここでやってるよ、だったらごめんなさい。見当たらなかったので再発明してしまいました。

中の仕組みはソースをみれば分かりますが、JavaScriptでは//のほかに<!--でも行末までコメントになるので、
それを利用している次第です。

Trackback URL for this post:

http://nonn-et-twk.net/twk/trackback/189
from twk @ ふらっと on 火, 2008-05-20 01:45

PHPには__halt_compiler()なんて言う関数があったんですね。
マニュアルでは埋め込んだインストールデータを読み込むのに使っていますが、
設定保存に使う例もあり、考え方次第で使えそうだ

0