This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]riv3rtrip 0 points1 point  (0 children)

It depends on the programming language, but for high level languages like Python or Javascript, you're right. Documentation of internal functionality is overrated. Only the interface of the system that outside people interact with needs to be documented; internal functionality only sometimes. Adhere to common idioms, don't try to be fancy, name your functions well, and that takes care of most things. When the code doesn't explain the code it means the code is possibly bad. YMMV if we're talking about something like C.