Kai Klostermann · @odddev
245 followers · 1542 posts · Server hachyderm.io

If you think is good at writing (comments, , commit messages etc.), you misunderstood the whole concept of documentation.

#ai #documentation #jsdocs

Last updated 1 year ago

@thilo I've not used external definitions much personally, except when I need to import a type from a library. @enhance_dev does a great job of using for types in their docs. @see: enhance.dev/docs/learn/practic

#typescript #jsdocs #jsdoc

Last updated 1 year ago

@thudfactor Typescript is a good linter, but nobody should ever feel bad about just telling it to ignore and getting back to work. This is why I use instead of syntax

#webdev #typescript #jsdocs

Last updated 1 year ago

@paulhmason +1 never having a problem with TypeErrors.

But I think types are actually valuable for

A) refactoring (errors can show you all the places your changes have effect)
B) interpreting other people's code (types can provide documentation, not just type)

I use with .

I avoid using syntax though. Linting errors should never prevent you from running code.

#typescript #vscode #jsdocs

Last updated 2 years ago

Daniel 🐘 Deboer · @dandb
89 followers · 1163 posts · Server mas.to

TIL you can import types into using @typedef:

/**
* @typedef { import("../setup").Tool } Tool
*/

#jsdocs #typescript

Last updated 2 years ago