使用通用Lisp,您可以添加许多docs字符串,例如:
CL-USER> (defun foo ()
"doc string for foo"
nil)
FOO
CL-USER> (documentation 'foo 'function)
"doc string for foo"
CL-USER> (describe 'foo)
COMMON-LISP-USER::FOO
[symbol]
FOO names a compiled function:
Lambda-list: ()
Derived type: (FUNCTION NIL (VALUES NULL &OPTIONAL))
Documentation:
doc string for foo
Source form:
(SB-INT:NAMED-LAMBDA FOO
NIL
"doc string for foo"
(BLOCK FOO NIL))
; No value
所以最终我可以读回文档字符串,但是使用符号和变量我无法通过文档将其取回:CL-USER> (defparameter bar 3 "doc string for bar")
BAR
CL-USER> (describe 'bar)
COMMON-LISP-USER::BAR
[symbol]
BAR names a special variable:
Value: 3
Documentation:
doc string for bar
; No value
CL-USER> (documentation 'bar 'symbol)
WARNING: unsupported DOCUMENTATION: doc-type SYMBOL for object of type SYMBOL
NIL
因此类型'symbol或我将使用哪种类型是错误的。我不确定到底会发生什么我正在使用:SBCL 1.3.10
最佳答案
让我们看看documentation
的文档;-)
CL-USER> (documentation 'documentation 'function)
"Return the documentation string of Doc-Type for X, or NIL if none
exists. System doc-types are VARIABLE, FUNCTION, STRUCTURE, TYPE, SETF, and T.
[...]"
所以:
CL-USER> (documentation 'bar 'variable)
"doc string for bar"
有关详细信息,请参见
documentation
。
关于common-lisp - 如何查看defparameter,defconstant或defvar的文档字符串?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40112343/