react-docgen
react-docgen copied to clipboard
Why not realize "//" which can also be a description?
" /** * */ " this can be regarded as a description. How about "//" ?
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.