Function DESCRIBE

UP


Function DESCRIBE

Function DESCRIBE

構文

describe object &optional stream => < 返却値なし >

引数と戻り値

object - オブジェクト
stream - 出力ストリーム指定子。デフォルトは標準出力。

定義

describeは、objectについての情報をstreamへ表示します。

例えば、シンボルのdescribeは、 シンボルの値、定義、各プロパティを表示するかもしれません。 浮動小数のdescribeは、 その数の内部表現の丸め誤差の方法が表示されるかもしれません。 しかしながら全ての場合において、 describeの性質と出力フォーマットは実装依存です。

describeobject内部に見られる何かについて describeすることができます。 このような場合、引数obojectの定義と 再帰的に呼び出された定義と視覚的に区別を行うために、 典型的にはデバイスの表現方法について インデントを増やしたり、テーブルの位置を変更したりします。

実際のオブジェクトの定義の動作は、 describe-objectによって実装されます。 describeはデフォルトの引数 (引数のtnilを ストリームオブジェクトへ変換する動作を含む)を 管理するための主なるインターフェイスとして存在し、 describe-objectから返却されるどのような値も抑止します。

describeはインタラクティブな関数であることを意図していません。 適合した実装では、 describeはデフォルトではプロンプトによる ユーザーの入力を受け付けてはいけません。 describe-objectのユーザー定義メソッドには同じ制限があります。

例文

なし。

副作用

標準出力化、ターミナルI/Oへ出力します。

影響

objectが保有するユーザー定義クラスへの describe-objectprint-objectそれぞれのメソッドにおける、 *standard-output**terminal-io*

例外

なし。

参考

inspect, describe-object

備考

なし。


TOP, Github