René's URL Explorer Experiment


Title: JSDoc : add support for @method (and @property) · Issue #28730 · microsoft/TypeScript · GitHub

Open Graph Title: JSDoc : add support for @method (and @property) · Issue #28730 · microsoft/TypeScript

X Title: JSDoc : add support for @method (and @property) · Issue #28730 · microsoft/TypeScript

Description: Search Terms JSDoc @method @property support Suggestion It would be great to add support for @method and @property (and maybe @memberof) now that annotations are on their way. I found bug #15715 that only talks about @property support bu...

Open Graph Description: Search Terms JSDoc @method @property support Suggestion It would be great to add support for @method and @property (and maybe @memberof) now that annotations are on their way. I found bug #15715 th...

X Description: Search Terms JSDoc @method @property support Suggestion It would be great to add support for @method and @property (and maybe @memberof) now that annotations are on their way. I found bug #15715 th...

Opengraph URL: https://github.com/microsoft/TypeScript/issues/28730

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"JSDoc : add support for @method (and @property)","articleBody":"## Search Terms\r\n\r\n* JSDoc\r\n* `@method`\r\n* `@property`\r\n* support \r\n\r\n## Suggestion\r\n\r\nIt would be great to add support for `@method` and `@property` (and maybe `@memberof`) now that annotations are on their way.\r\n\r\nI found bug #15715 that only talks about `@property` support but I think this makes more sense to see those in a same light because they should have a very common implementation and moreover they meet the same goals as a whole. At least I think and I explain my reasoning about this below!\r\n\r\n## Use Cases\r\n\r\nI have functions that do add methods and/or getters on a class right now, waiting for annotations to get their way in JS/TS. But let's say this: when annotations are here, those 2 flags support will be needed anyway (or at least I think so: I don't see how to make IntelliSense work without those)!\r\n\r\n```js\r\n/**\r\n* Some class\r\n * @class\r\n */\r\nclass Test {\r\n  /* whatever */\r\n}\r\n\r\n// this adds a #foo() method on the class prototype as well as a #bar getter(/setter)\r\nsomeMethodAddingABehavior(Test, ...params);\r\n```\r\n\r\nAnd tomorrow with annotations:\r\n```js\r\n/**\r\n* Some class\r\n * @class\r\n */\r\n@someAnnotationAddingABehavior(...params)\r\nclass Test {\r\n  /* whatever */\r\n}\r\n```\r\n\r\n## Examples\r\n\r\nI'd like to be able to document those doing something like:\r\n```js\r\n/**\r\n * What foo is doing is great!\r\n * @method foo\r\n * @param {string} testParam some testing parameter\r\n * @returns {string} some random string\r\n * @memberof Test.prototype\r\n */\r\n/**\r\n * Bar is awesome too!\r\n * @property {number} bar\r\n * @memberof Test.prototype\r\n */\r\nsomeMethodAddingABehavior(Test, ...params);\r\n```\r\n\r\nOr at least to be able to document them in the class itself:\r\n\r\n```js\r\n/**\r\n* Some class\r\n * @class\r\n */\r\nclass Test {\r\n  /* whatever */\r\n\r\n  /**\r\n   * What foo is doing is great!\r\n   * @method foo\r\n   * @param {string} testParam some testing parameter\r\n   * @returns {string} some random string\r\n   */\r\n  /**\r\n   * Bar is awesome too!\r\n   * @property {number} bar\r\n   */\r\n}\r\n```\r\n\r\nWith support of these, I would expect `vscode` to suggest to me the `foo` method and the `bar` property when completing properties of a value of type `Test`.\r\n\r\n## Checklist\r\n\r\nMy suggestion meets these guidelines:\r\n\r\n* [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [x] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [x] This could be implemented without emitting different JS based on the types of the expressions\r\n* [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)\r\n* [x] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).\r\n\r\n","author":{"url":"https://github.com/qraynaud","@type":"Person","name":"qraynaud"},"datePublished":"2018-11-29T09:57:31Z","url":"https://github.com/microsoft/TypeScript/issues/28730"}

react-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:df60409b-c23f-1658-9a4a-5c065ba262bb
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8ACA:172B92:ADD499:E9EA9E:6B00F1A2
html-safe-noncee09b3e531c79aea1c2add7acb0f15e095998c1a3abf44b8c60c72ed6a2953515
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QUNBOjE3MkI5MjpBREQ0OTk6RTlFQTlFOjZCMDBGMUEyIiwidmlzaXRvcl9pZCI6IjE0MzE2MzIyMTIwOTYyNTAyNzQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac88adda006293b039d13fd9c340f3008e4482549a790ed33893df295dca356e6e
hovercard-subject-tagissue:385654311
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/28730/issue_layout
twitter:imagehttps://opengraph.githubassets.com/fd54d869a5462af809a8b8da6a695d0b5fc299e383b1a8b41cf384565c24ab1b/microsoft/TypeScript/issues/28730
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/fd54d869a5462af809a8b8da6a695d0b5fc299e383b1a8b41cf384565c24ab1b/microsoft/TypeScript/issues/28730
og:image:altSearch Terms JSDoc @method @property support Suggestion It would be great to add support for @method and @property (and maybe @memberof) now that annotations are on their way. I found bug #15715 th...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameqraynaud
hostnamegithub.com
expected-hostnamegithub.com
None4ef498cbabcbe3c50befc7a5b743e7072ee770b4daf0e15e54801180d1fa91fc
turbo-cache-controlno-preview
go-importgithub.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git
octolytics-dimension-user_id6154722
octolytics-dimension-user_loginmicrosoft
octolytics-dimension-repository_id20929025
octolytics-dimension-repository_nwomicrosoft/TypeScript
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id20929025
octolytics-dimension-repository_network_root_nwomicrosoft/TypeScript
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release9983dd5da06943f833c971dd5b6bc988e2858be5
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/28730#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F28730
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F28730
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=microsoft%2FTypeScript
Reloadhttps://github.com/microsoft/TypeScript/issues/28730
Reloadhttps://github.com/microsoft/TypeScript/issues/28730
Reloadhttps://github.com/microsoft/TypeScript/issues/28730
microsofthttps://github.com/microsoft
TypeScripthttps://github.com/microsoft/TypeScript
Codehttps://github.com/microsoft/TypeScript
Issues5k (5k)https://github.com/microsoft/TypeScript/issues
Pull requests308 (308)https://github.com/microsoft/TypeScript/pulls
Actionshttps://github.com/microsoft/TypeScript/actions
Projectshttps://github.com/microsoft/TypeScript/projects
Wikihttps://github.com/microsoft/TypeScript/wiki
Security and qualityhttps://github.com/microsoft/TypeScript/security
Insightshttps://github.com/microsoft/TypeScript/insights
https://github.com/microsoft/TypeScript
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/28730
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/28730
JSDoc : add support for @method (and @property)https://github.com/microsoft/TypeScript/issues/28730#top
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
Domain: JavaScriptThe issue relates to JavaScript specificallyhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JavaScript%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com/qraynaud
Quentin Raynaud (qraynaud)https://github.com/qraynaud
on Nov 29, 2018https://github.com/microsoft/TypeScript/issues/28730#issue-385654311
#15715https://github.com/microsoft/TypeScript/issues/15715
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
Wesley Wigham (weswigham)https://github.com/weswigham
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
Domain: JavaScriptThe issue relates to JavaScript specificallyhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JavaScript%22
on Nov 30, 2018https://github.com/microsoft/TypeScript/issues/28730#event-1998681713
https://github.com/matt-tingen
Matt Tingen (matt-tingen)https://github.com/matt-tingen
on Jul 11, 2019https://github.com/microsoft/TypeScript/issues/28730#issuecomment-510489834
https://github.com/thw0rted
James Bromwell (thw0rted)https://github.com/thw0rted
on Nov 25, 2019https://github.com/microsoft/TypeScript/issues/28730#issuecomment-558223128
https://github.com/thw0rted
James Bromwell (thw0rted)https://github.com/thw0rted
on Nov 27, 2019https://github.com/microsoft/TypeScript/issues/28730#issuecomment-558993363
#7237https://github.com/microsoft/TypeScript/issues/7237
https://github.com/Jet132
Codec (Jet132)https://github.com/Jet132
on Mar 30, 2021https://github.com/microsoft/TypeScript/issues/28730#issuecomment-810073011
definite assignment assertionshttps://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#definite-assignment-assertions
this sectionhttps://www.typescriptlang.org/docs/handbook/2/classes.html#--strictpropertyinitialization:~:text=definite%20assignment%20assertion%20operator
https://github.com/alex-polosky
alex-poloskyhttps://github.com/alex-polosky
on Nov 15, 2022https://github.com/microsoft/TypeScript/issues/28730#issuecomment-1315777666
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/28730
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/28730
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
Domain: JavaScriptThe issue relates to JavaScript specificallyhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JavaScript%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.