Skip to content

re: Code for Humans VIEW POST

re: unless it is a framework, module, class, method, variable names should be self documenting without need of additional documentation Maybe I just ...

What I meant to say is, unless it's a framework, self-documenting code is enough, no need to have comments most of the time.
Frameworks too would follow the naming conventions, and on top of this they would also have the documentation/user-guides and comments that explicitly state the intent of code.

I would avoid adding too many comments within the domain/application specific projects, except when these are actually needed, like when there's a special branching instruction to handle rare edge case. The Why not the What.

I will try to rephrase this for more clarity. Thanks :)

code of conduct - report abuse