注释有三种

单行注释

单行注释以#开头。比如:

  1. # 这是一行注释
  2. var str = "Hello" # 这是另一个注释

文档注释

文档注释以##开头。比如:

  1. ## 这是一行注释
  2. var str = "Hello" ## 这是另一个注释

需要指出的是,文档注释是 token,它们只能出现在代码中特定的地方,因为它们属于语法树。这么做主要是方便文档生成器。

多行注释

多行注释以#[开头,以]#结尾。比如:

  1. #[
  2. 这里会有大段注释,
  3. 这是另一段注释
  4. ]#

需要指出的是,Nim 的多行注释和 Java 中不同,是可以嵌套的。比如:

  1. #[
  2. You can have any Nim code text commented
  3. out inside this with no indentation restrictions.
  4. yes("May I ask a pointless question?")
  5. #[
  6. Note: these can be nested!!
  7. ]#
  8. ]#