代码之家  ›  专栏  ›  技术社区  ›  vitaly-t

jsDoc代码示例中的多行注释

  •  2
  • vitaly-t  · 技术社区  · 6 年前

    如何在jsDoc示例中使用多行注释?

    /**
    * @example
    *
    * a.setConnection(/* connection details here */);
    *
    */
    

    引擎似乎根本不喜欢这样的代码。我试过使用HTML特殊符号,比如 +* connection details here *+

    我们怎样才能让它起作用?

    1 回复  |  直到 6 年前
        1
  •  1
  •   vitaly-t    6 年前

    正如我自己发现的,内部jsDoc不支持特殊符号 @example 封锁。它们只在内联代码块中工作,如下所示:

    ```js
    a.setConnection(/* connection details here */);
    ```
    

    输出: a.setConnection(/* connection details here */);

    ,不能将内联代码块放在所有内容之后,因为它是内联的,这意味着它将位于 @returns 章节。

    很尴尬,我知道,但别无选择。