Albin Jose to Programmer [email protected] • 1 year agoComment Your Code Peoplesuppo.fiimagemessage-square123fedilinkarrow-up11.57Karrow-down126
arrow-up11.54Karrow-down1imageComment Your Code Peoplesuppo.fiAlbin Jose to Programmer [email protected] • 1 year agomessage-square123fedilink
minus-squaremagic_lobster_partylinkfedilink0•1 year agoYou can find them by reading the code. It’s not difficult if they’re placed at proper locations.
minus-square@[email protected]linkfedilink2•1 year agoBut a major point of a function is that you not have to read its implementation details.
minus-squaremagic_lobster_partylinkfedilink1•1 year agoAccording to who? If I have access to the source code, which I often do, I’d rather just read the code. Chances are that if documentation exists, it’s no longer up to date.
minus-square@[email protected]linkfedilink2•1 year agoModularity. Part of it is defining a proper Interface for using the hidden complexity. Exceptions are only one example. Functions can have behavior, inner states, prior calling requirements etc… you cannot read from its mere prototype. Do you really want everyone to read the inner code to learn that? Chances are that if documentation exists, it’s no longer up to date. This risk also applies to descriptive function names. They can be poor, wrong or outdated, too.
You can find them by reading the code. It’s not difficult if they’re placed at proper locations.
But a major point of a function is that you not have to read its implementation details.
According to who? If I have access to the source code, which I often do, I’d rather just read the code. Chances are that if documentation exists, it’s no longer up to date.
Modularity. Part of it is defining a proper Interface for using the hidden complexity.
Exceptions are only one example. Functions can have behavior, inner states, prior calling requirements etc… you cannot read from its mere prototype.
Do you really want everyone to read the inner code to learn that?
This risk also applies to descriptive function names. They can be poor, wrong or outdated, too.