{message}
;\n});\n```\n\nFormats to:\n\n```js\n/** @type {React.FC<{message: string}>} */\nconst Component = memo(({ message }) => {\n return{message}
;\n});\n```\n\n#### TypeScript objects\n\n```js\n/**\n @typedef {\n {\n \"userId\": {\n \"profileImageLink\": *,\n \"isBusinessUser\": \"isResellerUser\"|\"isBoolean\"| \"isSubUser\" | \"isNot\",\n \"shareCode\": number,\n \"referredBy\": any,\n },\n id:number\n }\n } User\n */\n```\n\nFormat to:\n\n```js\n/**\n * @typedef {{\n * userId: {\n * profileImageLink: any;\n * isBusinessUser: \"isResellerUser\" | \"isBoolean\" | \"isSubUser\" | \"isNot\";\n * shareCode: number;\n * referredBy: any;\n * };\n * id: number;\n * }} User\n */\n```\n\n#### Example\n\nAdd code to `@examples` tag.\n\n```js\n/**\n * @examples\n * var one= 5\n * var two=10\n *\n * if(one > 2) { two += one }\n */\n```\n\nFormats to:\n\n```js\n/**\n * @example\n * var one = 5;\n * var two = 10;\n *\n * if (one > 2) {\n * two += one;\n * }\n */\n```\n\n#### Description\n\n`@description` is formatted as Markdown so that you can use any features of Markdown on that.\nLike code tags (` ```js `), header tags like `# Header`, or other Markdown features.\n\n## Options\n\n| Key | Type | Default | Description |\n| :---------------------------------- | :-------------------------------- | :----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `jsdocSpaces` | Number | 1 |\n| `jsdocDescriptionWithDot` | Boolean | false |\n| `jsdocDescriptionTag` | Boolean | false |\n| `jsdocVerticalAlignment` | Boolean | false |\n| `jsdocKeepUnParseAbleExampleIndent` | Boolean | false |\n| `jsdocCommentLineStrategy` | (\"singleLine\",\"multiline\",\"keep\") | \"singleLine\" |\n| `jsdocCapitalizeDescription` | Boolean | true |\n| `jsdocSeparateReturnsFromParam` | Boolean | false | Adds a space between last `@param` and `@returns` |\n| `jsdocSeparateTagGroups` | Boolean | false | Adds a space between tag groups |\n| `jsdocPreferCodeFences` | Boolean | false | Always fence code blocks (surround them by triple backticks) |\n| `jsdocEmptyCommentStrategy` | (\"remove\",\"keep\") | \"remove\" | How to handle empty JSDoc comment blocks |\n| `jsdocBracketSpacing` | Boolean | false | Whether to add spaces inside JSDoc type brackets. `{string}` (false) vs `{ string }` (true) |\n| `tsdoc` | Boolean | false | See [TSDoc](#tsdoc) |\n| `jsdocPrintWidth` | Number | undefined | If you don't set the value to `jsdocPrintWidth`, `printWidth` will be used as `jsdocPrintWidth` |\n| `jsdocLineWrappingStyle` | String | \"greedy\" | \"greedy\": lines wrap as soon as they reach `printWidth`. \"balance\": preserve existing line breaks if lines are shorter than `printWidth`, otherwise use greedy wrapping |\n| `jsdocTagsOrder` | String (object) | undefined | See [Custom Tags Order](doc/CUSTOM_TAGS_ORDER.md) |\n\n### TSDoc\n\nWe hope to support the whole [TSDoc](https://tsdoc.org/).\nIf we missed something, please [create an issue](https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/new).\n\nTo enable, add:\n\n```json\n{\n \"tsdoc\": true\n}\n```\n\n## Supported Prettier versions\n\n| Plugin version | Prettier version |\n| -------------- | ---------------- |\n| 1.0.0+ | 3.0.0+ |\n| 0.4.2 | 2.x+ |\n\n## Contributing\n\n1. Fork and clone the repository\n2. [Install Yarn](https://yarnpkg.com/getting-started/install)\n3. Install project dependencies:\n\n ```sh\n yarn install\n ```\n\n4. Make changes and make sure that tests pass:\n ```js\n yarn run test\n ```\n5. Update or add tests to your changes if needed\n6. Create PR\n\n## Links\n\n- [Prettier](https://prettier.io)\n- [JSDoc](https://jsdoc.app)\n\n## Acknowledge\n\nThis project extended from the @gum3n worked project on GitLab.\n","readmeFilename":"README.md","users":{"flumpus-dev":true}}