|
|
Subscribe / Log in / New account

Programmers are trained to write code, not read it.

Programmers are trained to write code, not read it.

Posted Jul 30, 2012 23:37 UTC (Mon) by neilbrown (subscriber, #359)
In reply to: Programmers are trained to write code, not read it. by kleptog
Parent article: Otte: staring into the abyss

I like to be welcomed when I go somewhere new, and that includes when I visit someone's code. Often all I get is a license statement (which is certainly useful) and then straight into the code.

Sometimes the function names and class names etc are welcoming enough, but often the import of the name doesn't become apparent until I understand the general structure of the code.

So a welcoming comment at the top which outlines what this file of code does and where it fits into the big picture is ... well ... welcoming!


to post comments


Copyright © 2025, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds