関数のドキュメント - sileのブログJavaにはJavadocという有名なドキュメントコメントがある。 (実践しているかどうかは別として)関数その他にドキュメントをつけるという考えは良いと思う。 ただ、Javadocの場合、名前の通り(一定の規約に従った)コメントを使って(関数その他の)文書化を行っているので、(多分)プログラム内からそのドキュメントにアクセスすることは出来ない(と思う)。 common lispの場合は、文書化のための機能があらかじめ言語に組み込まれている。 ;; ドキュメント付きの関数定義 > (defun doc-example () "関数定義の一番目の式が文字列の場合、その関数のドキュメントと認識される" 'done) --> DOC-EXAMPLE ;; ドキュメントを参照する > (documentation 'doc-example 'function) --> "関数定義の一番目の式が文字列
