Use the new JSDoc parser to handle @param tags #6867
Conversation
| parts.push(text.substr(start, rangeEnd - start)); | ||
| } | ||
|
|
||
| const result: SymbolDisplayPart = { |
There was a problem hiding this comment.
Why don't you just add a return type annotation and return the result directly?
|
Testing this with a JsDoc comment such as /**
* @param {string} p1 - A string param.
* Contact [email protected] for more info
* @param {string?} p2 - An optional param
* @param {string} [p3] - Another optional param. me@hotmail.
* @param {string} [p4="test"] - An optional param with a default value
* @return {string} This is the result
*/
function f1(p1, p2, p3, p4){}It seems to be caused by getCleanedJsDocComment, not specifically these changes, but in general looks like this code often treats |
| while (start < rangeEnd) { | ||
| const ch = text.charCodeAt(start); | ||
| if (ch === CharacterCodes.asterisk || isWhiteSpace(ch)) { | ||
| start++; |
There was a problem hiding this comment.
Adding the below to the if expression gets rid of the leading - in @param comments nicely for me 😄
|| (ch === CharacterCodes.minus && tag.kind === SyntaxKind.JSDocParameterTag)
|
I've spent three straight days on this and it's still not handling all the use cases we're inventing during development. This isn't a P1 for the 1.8 Salsa release so I'm going to close this and we can re-address at a later date unless there are substantial objections. |
Fixes #6810
We used to have two separate JSDoc Parameter Tag parsers -- one in services and one in parser. This PR removes the old tag parser in services and defers to the one in parser (which is more featureful and tested).
However, the parser doesn't extract doc comments (it leaves them as inter-node trivia), so we still need a function that extracts out the doc comments from a given JSDoc tag. This is now a general-purpose function
getCommentFromJsDocTagthat can do this for any kind of JSDoc tag (not just param tags).