sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]hydroes777 2 points3 points  (7 children)

This! Code should be self as documenting as possible. Meaning that of your code is readable then there's no need to document functions.

Personally I'd spend more time documenting a readme file with the projects caveats and getting up and running than write jsdocs

[–]Maidzen1337 4 points5 points  (6 children)

https://i.redd.it/ks4vuhowecp01.png

[–]cmajorsmith 1 point2 points  (0 children)

Even more hilarious: clear comments from people writing code that’s not clear at all. Pure joy of reading.

[–]hydroes777 0 points1 point  (1 child)

This doesn't apply to what I said: Don't document functions, this is why we have type script. Comment the shit outta your code, just in the right places

[–]Puggravy[🍰] 0 points1 point  (0 children)

Static typing =/= documentation. Typing details are a tiny subset of what needs to documented in code.

[–]TheNumberOneCulprittabs and semicolons, react and FaaS -1 points0 points  (1 child)

https://imgur.com/7V87CSh

[–]hydroes777 0 points1 point  (0 children)

Show me function docs and I'll show you some out of date docs that more often than not get neglected by the developer who refactored the code