Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE REQUEST] Support multi-line JSDoc comments at runtime #1777

Open
smorimoto opened this issue Dec 21, 2024 · 0 comments
Open

[FEATURE REQUEST] Support multi-line JSDoc comments at runtime #1777

smorimoto opened this issue Dec 21, 2024 · 0 comments

Comments

@smorimoto
Copy link
Member

smorimoto commented Dec 21, 2024

Is your feature request related to a problem? Please describe.

I wish to have support for a more comprehensive comment format to allow runtime type checking with the TypeScript compiler.

Describe the solution you'd like

Support multi-line JSDoc comments like this:

/** 
 * Provides: xxxxx
 * Requires: xxxxx
 */
function xxxxx(x1, x2) {
  ...
}
/**
 * @param {string} x1 - A string param. 
 * @param {string} [x2] - An optional param (JSDoc syntax).
 * @returns {number} This is the result.
 * Provides: xxxxx
 * Requires: xxxxx
 */
function xxxxx(x1, x2) {
  ...
}

Ref: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

Describe alternatives you've considered

I'm looking for your comments to get better ideas!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant