Title: chore: fix / clean up jsdoc comments · Issue #1342 · TheAlgorithms/JavaScript · GitHub
Open Graph Title: chore: fix / clean up jsdoc comments · Issue #1342 · TheAlgorithms/JavaScript
X Title: chore: fix / clean up jsdoc comments · Issue #1342 · TheAlgorithms/JavaScript
Description: Motivation Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before class to before constructor would definitely help many beginners using this librar...
Open Graph Description: Motivation Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before class to before constructor would definite...
X Description: Motivation Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before class to before constructor would definite...
Opengraph URL: https://github.com/TheAlgorithms/JavaScript/issues/1342
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"chore: fix / clean up jsdoc comments","articleBody":"### Motivation\r\n\r\nMany people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before `class` to before `constructor` would definitely help many beginners using this library. Then, the descriptions would show up for the parameters as well.\r\n\r\n### Examples\r\n\r\n_No response_\r\n\r\n### Possible workarounds\r\n\r\nThe possible workaround is that instead of moving the jsdoc completely to before `constructor`, the description can stay before `class` but the `@param` needs to be moved to before `constructor`\r\n\r\n### Additional information\r\n\r\n> You don't need to use tags such as `@class` and `@constructor` with ES 2015 classes—JSDoc automatically identifies classes and their constructors simply by parsing your code.\r\n\r\nas stated by the [documentation for classes](https://jsdoc.app/howto-es2015-classes.html)","author":{"url":"https://github.com/Zatan16","@type":"Person","name":"Zatan16"},"datePublished":"2023-07-28T10:16:36Z","url":"https://github.com/TheAlgorithms/JavaScript/issues/1342"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:7c7126e4-345a-cc70-9c8c-b606e6f284d4 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 853E:2A7C1C:C6F3CF:106ED66:6B01C6FC |
| html-safe-nonce | f9bd3398be07f79f1750da35723ae27b12e34bf8b6654a67dcf094379af37707 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NTNFOjJBN0MxQzpDNkYzQ0Y6MTA2RUQ2Njo2QjAxQzZGQyIsInZpc2l0b3JfaWQiOiIxNDQ0ODE0MTIzODU3NzI1MTgwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | b75f323d96c053e1a47cd6b8a8c75a27f79a2d43b1a9bd69fe199a64c3d63f2c |
| hovercard-subject-tag | issue:1826159758 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/TheAlgorithms/JavaScript/1342/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2c7ba16d99ffe94130c72e6fe09b5bd31352e30501775f3ff81ed0cbb2bab1ac/TheAlgorithms/JavaScript/issues/1342 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2c7ba16d99ffe94130c72e6fe09b5bd31352e30501775f3ff81ed0cbb2bab1ac/TheAlgorithms/JavaScript/issues/1342 |
| og:image:alt | Motivation Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before class to before constructor would definite... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Zatan16 |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/TheAlgorithms/JavaScript git https://github.com/TheAlgorithms/JavaScript.git |
| octolytics-dimension-user_id | 20487725 |
| octolytics-dimension-user_login | TheAlgorithms |
| octolytics-dimension-repository_id | 97086543 |
| octolytics-dimension-repository_nwo | TheAlgorithms/JavaScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 97086543 |
| octolytics-dimension-repository_network_root_nwo | TheAlgorithms/JavaScript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width