Title: JsDoc for overloads · Issue #3294 · microsoft/TypeScript · GitHub
Open Graph Title: JsDoc for overloads · Issue #3294 · microsoft/TypeScript
X Title: JsDoc for overloads · Issue #3294 · microsoft/TypeScript
Description: When adding JSDoc to an overloaded function, It seems that the JSDoc comment must immediately precede the actual function. When preceding the list of overloads, the JSDoc comment is dropped after compilation. Example: module app { /** * ...
Open Graph Description: When adding JSDoc to an overloaded function, It seems that the JSDoc comment must immediately precede the actual function. When preceding the list of overloads, the JSDoc comment is dropped after c...
X Description: When adding JSDoc to an overloaded function, It seems that the JSDoc comment must immediately precede the actual function. When preceding the list of overloads, the JSDoc comment is dropped after c...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/3294
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"JsDoc for overloads","articleBody":"When adding JSDoc to an overloaded function, It seems that the JSDoc comment must immediately precede the actual function. When preceding the list of overloads, the JSDoc comment is dropped after compilation.\n\nExample:\n\nmodule app {\n\n```\n/**\n * Returns \"foo\"\n * \n * this doesn't output.\n */\nexport function foo(x: string): string;\nexport function foo(x: number): string;\nexport function foo(x: any): string {\n return \"foo\";\n}\n\n\nexport function bar(x: string): string;\nexport function bar(x: number): string;\n\n/**\n * Returns \"bar\"\n * \n * this will output. but I don't like my overloads detached.\n */\nexport function bar(x: any): string {\n return \"bar\";\n}\n```\n\n}\n","author":{"url":"https://github.com/danmarshall","@type":"Person","name":"danmarshall"},"datePublished":"2015-05-28T20:55:45Z","url":"https://github.com/microsoft/TypeScript/issues/3294"}
| 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:9e4309f5-eb96-3051-7226-61557b5acd9f |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A72A:2F9AA4:3F2A6D:53AEA4:6B01736E |
| html-safe-nonce | 7c18df6a30213bcde779875cd2f90792bd17135ccf9f9b9caf087ad04fe5abe5 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNzJBOjJGOUFBNDozRjJBNkQ6NTNBRUE0OjZCMDE3MzZFIiwidmlzaXRvcl9pZCI6IjIyNTc5NjA3NjEzODMwMjM0NzAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 74f0fde8d5dc35a68ea4f1962829a18cf484be5dce91fa92f62f80e9b89d537e |
| hovercard-subject-tag | issue:82120757 |
| 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/microsoft/TypeScript/3294/issue_layout |
| twitter:image | https://opengraph.githubassets.com/06acbfee2eee411319c7b286105dc9d1d649031489634d1afe960291aabbc3a0/microsoft/TypeScript/issues/3294 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/06acbfee2eee411319c7b286105dc9d1d649031489634d1afe960291aabbc3a0/microsoft/TypeScript/issues/3294 |
| og:image:alt | When adding JSDoc to an overloaded function, It seems that the JSDoc comment must immediately precede the actual function. When preceding the list of overloads, the JSDoc comment is dropped after c... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | danmarshall |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| 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 | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width