You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Similar to #160 but it sounds that Github has a magic behavior that solves it. I don't let render the markdown in Github, but in Storybook. And in Storybook it looks the same as in PhpStorm.
Optional parameters and default values
The following examples show how to indicate that a parameter is optional and has a default value.
An optional parameter (using JSDoc syntax)
Similar to #160 but it sounds that Github has a magic behavior that solves it. I don't let render the markdown in Github, but in Storybook. And in Storybook it looks the same as in PhpStorm.
So the official docs of @param says:
So when I do this (I need extra
@module
to let the Markdown content being created)The rendered results has no explicit optional indication.
PhpStorm
Storybook
When I add a required parameter
There is still no explicit distinction, except the in-name literal brackets.
PhpStorm
Storybook
Same problem when using @property
PhpStorm
Storybook
What is expected
My expectation is that an additional column should be rendered, which explicitely indicates if the param is required or optional.
The text was updated successfully, but these errors were encountered: