Deno: Support Rust-style triple slash comments for "deno doc"

Created on 7 Apr 2020  路  2Comments  路  Source: denoland/deno

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.

cli suggestion

Most helpful comment

All 2 comments

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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ry picture ry  路  3Comments

CruxCv picture CruxCv  路  3Comments

kyeotic picture kyeotic  路  3Comments

davidbarratt picture davidbarratt  路  3Comments

zugende picture zugende  路  3Comments