Feb 6

逆引きrhaco(?)17: クラスドキュメントを見る

rhacoは「マニュアルが無い」とか「チュートリアルが(ry」とか言われることがあるんですが、rhacoではクラスドキュメントを見ることである程度分かる部分があります。

実際は「自由度が他のフレームワークと比べてありすぎる」ことで迷ったりするのですが(私がそうでした)、ライブラリとしてのrhacoの側面が分かると思って下さい。

やりかたはsetup.phpで表示される設定メニューから「rhacodoc」をクリックするだけ。

すると以下のように表示されます。

 Rhaco
(Rhaco.php)
@author Kazutaka Tokushima
@license New BSD License
@copyright Copyright 2005- The Rhacophorus Project. All rights reserved.
---
---
isphp
指定のバージョン以上のPHPか

@param unknown_type $version
@return unknown
---
version
アプリケーションのバージョン

@return unknown
---
constant
定数定義

@param string $defineName
@param string $value
@return string
eq(null,Rhaco::constant("hoge"));
eq(123,Rhaco::constant("hoge",123));
eq(123,Rhaco::constant("hoge"));
assert(defined("hoge"));
eq(123,Rhaco::constant("hoge",789));
eq(123,Rhaco::constant("hoge"));

.....以下続く

このようにクラス名、ファイルパス、メソッド名、概要、引数、テストコードが表示されます。これを見て使いたい関数があったらRhaco::importして使ってみれば良いと思います。テストが無い箇所も結構あるのですが、十分参考になると思います。

情報はtrunkのrev 2674を元にしています。リリース版では無い機能だったと思いますが、興味のある人はsvnでtrunkを取得して試してみれば良いと思います。

※テストを書いて下さる方など歓迎中だそうです。rhaco-jaなどで叫んでいただければrhacoの人が対応すると思います:P

| comment(0)