search

atom / atom-languageclient

Language Server Protocol support for Atom (the basis of Atom-IDE)
https://ide.atom.io/
MIT License
389 stars 78 forks source link

Convert doc comments to TSDoc syntax #263

Closed Aerijo closed 5 years ago

Aerijo commented 5 years ago

The current comments are very informative, but were not being picked up by ide-typescript. This converts them to a more standardised format, which is recognised.

Note it is not exactly a TSDoc match (which is quite difficult, considering TSDoc does not actually provide a spec yet...). However, it is clearly picked up and parsed by ide-typescript, so will suffice.

The only concern would be the {reference} syntax, which Atom likes to pick up as something (but not what it's meant to be) but ide-typescript ignores. It currently makes a lot of these comments very red.

I plan to merge anyway, short of any suggestions from @damieng or others about why the original syntax was used, because useful doc comments are more valuable than locally broken syntax highlighting IMO.

damieng commented 5 years ago

The original syntax was based on some syntax elsewhere in Atom but if you can get decent docs out of it or make TypeScript pick it up with alternative syntax go for it!