pycodestyle
pycodestyle copied to clipboard
Tip for svelte components to add Intelliense hover hint for params.
In any svelte component, you can add this HTML comment to add intellisense hints.
<!--
@component
## Example Heading
@param exampleParam - An example parameter description
-->
This means you can document all the available props, so use of the lib can see what is available and how to use the props without always going back to the website documentation.
Example
- With a custom Svelte component here I called
MyNode.svelte, I added the HTML comment with the @component and @props tags.
Now I get a hint
- Whenever I hover over my imported component based on that contents of that HTML @component comment.
Thus this a can be done with all Svelvet svelte components.