besenwagen / m.bednarz.dev Goto Github PK

After the obligatory Quixotic Sturm & Drang period it is time to bite the bullet and remove JSDoc. The supposed benefits simply do not adjust the overhead.

Useful stuff that's going away: quick documentation in IDEs.

Stuff that never really worked in the first place:

Documentation

• JSDoc still largely useless for ES >= 2015
• ESDoc is dead without an authoritative fork

Static type analysis

• Depends on VSCode
• Depends on a Docker container with Node (or a shoot yourself in the foot host environment)
• Turns out to be counter productive for DOM scripting unless you exclusively develop in a framework ghetto
• Turns out to be mostly useful for finding mistakes in your DocBlocks 🙄