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

Support Rust-style triple slash comments for "deno doc" #4666

Closed
ry opened this issue Apr 7, 2020 · 6 comments
Closed

Support Rust-style triple slash comments for "deno doc" #4666

ry opened this issue Apr 7, 2020 · 6 comments
Labels
cli related to cli/ dir suggestion suggestions for new features (yet to be agreed)

Comments

@ry
Copy link
Member

ry commented Apr 7, 2020

The jsdoc syntax is pretty obnoxious. It often results in two extra lines just source code.

The only thing speaking against this is that it's non-standard. But jsdoc is not a ecmascript standard - and hopefully it will not be. I think we should try to put the language in better directions where possible.

@kitsonk
Copy link
Contributor

kitsonk commented Apr 7, 2020

The TypeScript compiler understands JSDoc, which provides a significantly improved developer experience in visual editors, both with TypeScript and JavaScript. To move to something else, we would need to re-implement all the semantics and parsing that is built into the TypeScript compiler and create a new language service which can be integrated into plugins to provide that rich information, just to get back to parity with the current experience and expectations. In fact, JSDoc can provide type information for JavaScript which can be enforced by the TypeScript compiler, and Deno, right now.

Also, there is a significant cowpath for JSDoc that won't ever go away. The only real movement in this space is actually for enhancements to JSDoc, like TSDoc (https://github.com/microsoft/tsdoc).

While I understand the sentiment, there feels like there are a lot of other windmills we could tilt at.

@bartlomieju bartlomieju added cli related to cli/ dir suggestion suggestions for new features (yet to be agreed) labels May 21, 2020
@kitsonk
Copy link
Contributor

kitsonk commented Aug 6, 2020

Ref: microsoft/TypeScript#39930

@aapoalas
Copy link
Collaborator

The TS experiment has been closed. I'd like to close this.

@crowlKats
Copy link
Member

I think its still valid to keep this around; i think it makes sense. we dont strictly stick to what TSDoc implements for deno_doc anyway, due to the slow development there, and often pull in features from JSDoc.

@kj
Copy link

kj commented Feb 13, 2023

The TS experiment has been closed. I'd like to close this.

The author of the linked PR closed it, but the issue is still open: microsoft/tsdoc#160

I hope this issue won't be closed.

@lucacasonato
Copy link
Member

We're not going to do this. One style of comments is fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli related to cli/ dir suggestion suggestions for new features (yet to be agreed)
Projects
None yet
Development

No branches or pull requests

7 participants