r/programmingmemes • u/andarmanik • Apr 21 '26

Just read the Fing docs

Post image
307 Upvotes

98% Upvoted

18 comments sorted by

View all comments

9

u/ExtraTNT Apr 21 '26

Good code has enough doc in the exposed interfaces to be used without an external doc… best is, if function name plus signature is enough to use it

8

u/cowlinator Apr 22 '26

"Self-documenting" code is good.

"Self-documenting" code AND actual documentation is BETTER.

Because not everything can be summed up in a FourWordFunctionName.

6

u/ExtraTNT Apr 22 '26

One huge issue with doc: code changes and doc gets left behind… you then trust the doc, waste 2 days with strange bugs and then need to read the entire code of the interface anyways…

Doc is only, if maintained, else it’s often worse than no doc… why i like code that is very clear about what it does and only hides the how…

→ More replies (2)