Storybook docs page displays extra JSDOC tags in description

Question

My component's description on the Storybook Docs page is picking up extra tags stuff from the JSDocs in addition to the description.

How can I go about displaying only the "description part" of the JSDOC description?

I've attempted explicitly specifying a @description tag but that didn't do anything.

Natishanative

Hey, did you find a solution? – Bottali

any update on this? 2 years and no support? not to throw shade, but it seems like storybook doesn't understand jsdocs is used – Dacia

Answer 1

Use following workaround to get rid of extra jsdoc tag.

/**
 * A simple Button component.
 * <!--
 * @param {Object} props - The props of the Button component.
 * @param {string} props.label - The label of the button.
 * @param {Function} props.onClick - The click event handler of the button.
 * @returns {JSX.Element} The rendered Button component.
 * -->
 */
const Button = ({ label, onClick }) => {
    return (
        <button onClick={onClick}>
            {label}
        </button>
    );
};

Demilune