用于匹配文档 block 内的 JSDoc 标记的 Javascript 正则表达式

Question

所以现在我可以隔离代码中的每个 JSDoc(ish) block ，例如我在这里有这个 block

/// @tag {type} name description
/// description continue
/// another description line
/// @tag {type} name description
/// description continue
/// @tag name description just one line.
/// @tag {type} name

我想使用正则表达式来匹配 block 内的每个标签标签需要有一个@name格式那么它可以有一个类型 {type} (可选)那么它需要一个 name最后它可以有一个描述.. 描述可以是多行的也可以是单行的(也是可选的)。所以

我想出的正则表达式是:

^\/{3} @(?<tag>\w+)(?:[ \t]+{(?<type>.*)})?(?:[ \t]+(?<name>\w+))(?:[ \t]+(?<desc>[\s\S]*))?

我的问题是一旦我点击描述它就不会在下一个标签的开头停止......我觉得现在我正在使用贪婪的方法但我找不到等待使其非贪婪。

所以上面的例子匹配:

标签:tag

姓名:name

描述:

description
/// description continue
/// another description line
/// @tag {type} name description
/// description continue
/// @tag name description just one line.
/// @tag {type} name

我希望描述在新标签开始或 block 结束时停止

Answer 1

使用

/^\/{3} @(?<tag>\w+)(?:[ \t]+{(?<type>[^{}]*)})?[ \t]+(?<name>\w+)(?:[ \t]+(?<desc>.*(?:\n(?!\/{3} @\w).*)*))?/gm

参见 regex proof .

解释

--------------------------------------------------------------------------------
  ^                        the beginning of the string
--------------------------------------------------------------------------------
  \/{3}                    '/' (3 times)
--------------------------------------------------------------------------------
   @                       ' @'
--------------------------------------------------------------------------------
  (?<tag>                  group and capture to \k<tag>:
--------------------------------------------------------------------------------
    \w+                      word characters (a-z, A-Z, 0-9, _) (1 or
                             more times (matching the most amount
                             possible))
--------------------------------------------------------------------------------
  )                        end of \k<tag>
--------------------------------------------------------------------------------
  (?:                      group, but do not capture (optional
                           (matching the most amount possible)):
--------------------------------------------------------------------------------
    [ \t]+                   any character of: ' ', '\t' (tab) (1 or
                             more times (matching the most amount
                             possible))
--------------------------------------------------------------------------------
    {                        '{'
--------------------------------------------------------------------------------
    (?<type>                group and capture to \k<type>:
--------------------------------------------------------------------------------
      [^{}]*                   any character except: '{', '}' (0 or
                               more times (matching the most amount
                               possible))
--------------------------------------------------------------------------------
    )                        end of \k<type>
--------------------------------------------------------------------------------
    }                        '}'
--------------------------------------------------------------------------------
  )?                       end of grouping
--------------------------------------------------------------------------------
  [ \t]+                   any character of: ' ', '\t' (tab) (1 or
                           more times (matching the most amount
                           possible))
--------------------------------------------------------------------------------
  (?<name>                 group and capture to \k<name>:
--------------------------------------------------------------------------------
    \w+                      word characters (a-z, A-Z, 0-9, _) (1 or
                             more times (matching the most amount
                             possible))
--------------------------------------------------------------------------------
  )                        end of \k<name>
--------------------------------------------------------------------------------
  (?:                      group, but do not capture (optional
                           (matching the most amount possible)):
--------------------------------------------------------------------------------
    [ \t]+                   any character of: ' ', '\t' (tab) (1 or
                             more times (matching the most amount
                             possible))
--------------------------------------------------------------------------------
    (?<desc>                 group and capture to \k<desc>:
--------------------------------------------------------------------------------
      .*                       any character except \n (0 or more
                               times (matching the most amount
                               possible))
--------------------------------------------------------------------------------
      (?:                      group, but do not capture (0 or more
                               times (matching the most amount
                               possible)):
--------------------------------------------------------------------------------
        \n                       '\n' (newline)
--------------------------------------------------------------------------------
        (?!                      look ahead to see if there is not:
--------------------------------------------------------------------------------
          \/{3}                    '/' (3 times)
--------------------------------------------------------------------------------
           @                       ' @'
--------------------------------------------------------------------------------
          \w                       word characters (a-z, A-Z, 0-9, _)
--------------------------------------------------------------------------------
        )                        end of look-ahead
--------------------------------------------------------------------------------
        .*                       any character except \n (0 or more
                                 times (matching the most amount
                                 possible))
--------------------------------------------------------------------------------
      )*                       end of grouping
--------------------------------------------------------------------------------
    )                        end of \k<desc>
--------------------------------------------------------------------------------
  )?                       end of grouping