×

Announcing: Slashdot Deals - Explore geek apps, games, gadgets and more. (what is this?)

Thank you!

We are sorry to see you leave - Beta is different and we value the time you took to try it out. Before you decide to go, please take a look at some value-adds for Beta and learn more about it. Thank you for reading Slashdot, and for making the site better!

Comments

top

What is Well-Commented Code?

Random Man Architecture and Flow of Control comments (826 comments)

Far too late to join this conversation, but let me add my $0.02 anyway.

What I miss most in most source code are comments that communicate the architecture and flow of control at the module level. When you get the source code for a project, it's generally a flat list of files. Where do you start? main() is not always the right answer - what's needed is an overall look at the code base and a guide to how it was put together.

Comments in the source rarely address these questions, being more locally oriented as a rule.

more than 12 years ago

Submissions

Random Man hasn't submitted any stories.

Journals

Random Man has no journal entries.

Slashdot Login

Need an Account?

Forgot your password?