JSDoc fixes - Modify defaults, param name optional and new type support

[bgriffith]

Few fixes in this PR 🎉

Fix 1 - Modify defaults

This PR switches what JSDoc defaults to when deciding how many captures to check for. Currently it defaults to 4 with one requiring an @return or @returns tag to only check for 3.

Having read the docs further, it's become obvious that 3 should be the default for all tags except for when we have a @param or @type which then requires 4.

Fix 2 - Make param name optional

I've also made the param name optional and this change fixes an issue with tags that only have a type specified.

Before:

After:

Fix 3 - Add support for types with a set of type arguments

Adds support a type with a set of type arguments. I.e. Array<string> an array of strings.

Before:

After:

Fix 4 - Add support for unknown type

Adds support for the unknown type {?}

Before:

After:

Fix 5 - Add support for key-value pair types

Adds support for specifying the types of key-value pairs within the parameter.

Before:

After:

Lastly

🎨 Added whitespace to break up extremely long JSDoc rules and increase readability. (Please let me know if there's a specific style I should follow!)

[winstliu]

Can you also add some comments for people not familiar with the JSDoc syntax? For example, adding a comment after the \\? to signify that that's the unknown type.

(It'll also help me to review a lot easier :))

[winstliu]

I don't think the ! needs to be escaped.

[bgriffith]

@50Wliu Hey! Sure will do. Can you give me a heads up on how to comment within an extended match? What's the syntax? I can't seem to find an example.

[Alhadis]

(?# This) or # This.

Also, install this.

EDIT: 👇 Yeah, that.

[winstliu]

Just <your regex> # comment in an extended regex. As long as the comment is at the end of the line you're fine.

[bgriffith]

@Alhadis @50Wliu Cheers guys 👍

[bgriffith]

@50Wliu Something like that ok?

[winstliu]

Yeah - that helps so much!