react-docgen icon indicating copy to clipboard operation
react-docgen copied to clipboard

Why not realize "//" which can also be a description?

Open ShouriYang opened this issue 5 years ago • 1 comments

" /** * */ " this can be regarded as a description. How about "//" ?

ShouriYang avatar Jan 14 '20 07:01 ShouriYang

Because by widely adopted convention a JSDoc comment beginning with /** denotes a documentation comment, while // does not. This is for good reason; what if you do // eslint-disable-next-line foo/bar before your React component declaration? You don't want that to end up in the documentation as the component’s description.

jaydenseric avatar Jul 03 '23 01:07 jaydenseric