Nim 相当于 python 的 `help()`

Question

nim 是否编译文档字符串，以便我们可以在运行时回应它们？

类似于：

>>> echo help(echo)
"Writes and flushes the parameters to the standard output.[...]"

Answer 1

已编辑：有一种方法可以实现帮助功能

原来使用macros.getImpl it is possible to implement a functionality similar to the echo you report above (playground):

import macros

macro implToStr*(ident: typed): string =
  toStrLit(getImpl(ident))
template help*(ident: typed) =
  echo implToStr(ident)

help(echo)

输出：

proc echo(x: varargs[typed, `$`]) {.magic: "Echo", tags: [WriteIOEffect],
                                    gcsafe, locks: 0, sideEffect.}
  ## Writes and flushes the parameters to the standard output.
                                                                  ## 
                                                                  ## Special built-in that takes a variable number of arguments. Each argument
                                                                  ## is converted to a string via ``$``, so it works for user-defined
                                                                  ## types that have an overloaded ``$`` operator.
                                                                  ## It is roughly equivalent to ``writeLine(stdout, x); flushFile(stdout)``, but
                                                                  ## available for the JavaScript target too.
                                                                  ## 
                                                                  ## Unlike other IO operations this is guaranteed to be thread-safe as
                                                                  ## ``echo`` is very often used for debugging convenience. If you want to use
                                                                  ## ``echo`` inside a `proc without side effects
                                                                  ## <manual.html#pragmas-nosideeffect-pragma>`_ you can use `debugEcho
                                                                  ## <#debugEcho,varargs[typed,]>`_ instead.

输出有点不稳定（在文档字符串的第一行之后有一个非常大的缩进）并且它有一些限制：它不适用于某些符号 - 例如它适用于 toStrLit 但不适用于 getImpl；它不会在过载时工作。将来可能会通过更好的实施或修复 compiler/stdlib.

来改善这些限制

上一个回答

不，Nim 不会编译文档字符串（编辑：文档字符串在运行时不可用，但它们是 AST 的一部分，可以在编译时访问，见上文).使用受支持的编辑器，您可以获得帮助，将鼠标悬停在标识符上或转到源代码中的定义。

例如在 VS Code（带有 Nim 扩展）中，将鼠标悬停在 echo 上会得到：

然后按 F12（在 Windows 上）将转到 systems.nim 中的 echo 定义。

标准库标识符的另一个有用资源是 searchable index.

Nim 相当于 python 的 `help()`

Nim equivalent to python's `help()`

python

documentation

docstring

nim-lang

已编辑：有一种方法可以实现帮助功能

上一个回答