UP

Standard-Generic-Function DOCUMENTATION

構文

documentation x doc-type => documentation
( setf documentation ) new-value x doc-type => new-value

引数の優先順位

doc-type, object

メソッド宣言

関数、マクロ、特殊フォーム:

documentation ( x function ) ( doc-type ( eql ' t ) )
documentation ( x function ) ( doc-type ( eql ' function ) )
documentation ( x list ) ( doc-type ( eql ' function ) )
documentation ( x list ) ( doc-type ( eql ' compiler-macro ) )
documentation ( x symbol ) ( doc-type ( eql ' function ) )
documentation ( x symbol ) ( doc-type ( eql ' compiler-macro ) )
documentation ( x symbol ) ( doc-type ( eql ' setf ) )
( setf documentation ) new-value ( x function ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x function ) ( doc-type ( eql ' function ) )
( setf documentation ) new-value ( x list ) ( doc-type ( eql ' function ) )
( setf documentation ) new-value ( x list ) ( doc-type ( eql ' compiler-macro ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' function ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' compiler-macro ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' setf ) )

method-combination:

documentation ( x method-combination ) ( doc-type ( eql ' t ) )
documentation ( x method-combination ) ( doc-type ( eql ' method-combination ) )
documentation ( x symbol ) ( doc-type ( eql ' method-combination ) )
( setf documentation ) new-value ( x method-combination ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x method-combination ) ( doc-type ( eql ' method-combination ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' method-combination ) )

メソッド:

documentation ( x standard-method ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x standard-method ) ( doc-type ( eql ' t ) )

パッケージ:

documentation ( x package ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x package ) ( doc-type ( eql ' t ) )

型、クラス、構造体の名前:

documentation ( x standard-class ) ( doc-type ( eql ' t ) )
documentation ( x standard-class ) ( doc-type ( eql ' type ) )
documentation ( x structure-class ) ( doc-type ( eql ' t ) )
documentation ( x structure-class ) ( doc-type ( eql ' type ) )
documentation ( x symbol ) ( doc-type ( eql ' type ) )
documentation ( x symbol ) ( doc-type ( eql ' structure ) )
( setf documentation ) new-value ( x standard-class ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x standard-class ) ( doc-type ( eql ' type ) )
( setf documentation ) new-value ( x structure-class ) ( doc-type ( eql ' t ) )
( setf documentation ) new-value ( x structure-class ) ( doc-type ( eql ' type ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' type ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' structure ) )

変数:

documentation ( x symbol ) ( doc-type ( eql ' variable ) )
( setf documentation ) new-value ( x symbol ) ( doc-type ( eql ' variable ) )

引数と戻り値

x - オブジェクト
doc-type - シンボル
documentation - 文字列か、nil
new-value - 文字列

定義

ジェネリック関数documentationは、 もし引数のオブジェクトに関連付けられたものが利用可能なとき、 そのドキュメント文字列を返却します。 そうではないときは、nilを返却します。

ジェネリック関数(setf documentation)は、 xに関連付けられたドキュメント文字列をnew-valueに更新します。 もしxがリストのとき、それは(setf symbol)のフォームでなければなりません。

ドキュメント文字列はデバッグ目的で利用できます。 適合するプログラムは、ドキュメント文字列が存在するときは それを使うことが許されていますが、 それらドキュメント文字列の存在が正しく返却されるような動作に 依存してはいけません。 実装はどんな時でも、実装定義の理由で ドキュメント文字列を切り捨てることが許されます。

返却されるドキュメント文字列の性質は、 doc-typeにより下記に示すようなものに依存します。

• compiler-macro
  • xという関数名のコンパイラーマクロのドキュメント文字列を返却します。
• function
  • もしxが関数名のとき、xという名前の関数か、マクロか、特殊フォームかの ドキュメント文字列を返却します。
  • もしxが関数のとき、xに関連づいたドキュメント文字列を返却します。
• method-combination
  • もしxがシンボルのとき、xという名前のmethod-combinationの ドキュメント文字列を返却します。
  • もしxがmethod-combinationのとき、 xに関連づいたドキュメント文字列を返却します。
• setf
  • シンボルxという名前のsetf-expanderの ドキュメント文字列を返却します。
• structure
  • 構造体名xに関連づいたドキュメント文字列を返却します。
• t
  • 引数x自身のクラスで特定化されたドキュメント文字列を返却します。 例えばxが関数のとき、関数xに関連づいたドキュメント文字列が返却されます。
• type
  • もしxがシンボルのとき、シンボルxという名前のクラスが存在するならば、 そのクラスのドキュメント文字列を返却します。 それ以外のときは、シンボルxの型指定子が示す型の ドキュメント文字列を返却します。
  • もしxがstructure-classかstandard-classのインスタンスのとき、 クラスxに関連づいたドキュメント文字列を返却します。
• variable
  • シンボルxという名前の動的変数か定数変数の ドキュメント文字列を返却します。

適合する実装か、適合するプログラムは、 doc-typeとして許容可能なシンボルの集合を拡張するかもしれません。

例文

なし。

影響

なし。

例外

なし。

参考

なし。

備考

標準では、ドキュメント文字列は defclassフォームによって指定された個別スロットから 取得するという意味で定めているのではありません。 しかし実装はこの情報を処理するような デバッグツールやプログラミング言語の拡張を提供するかもしれません。 このようなサポートの提供を行いたいような実装者は、 どのようにしてそれを行うかについての方法を得るために、 Metaobject Protocolを調査することをお勧めします。

TOP, Github