Code Reading: The Open Source Perspective 464
| Code Reading: The Open Source Perspective | |
| author | Diomidis Spinellis |
| pages | 499 |
| publisher | Addison-Weslet Longman |
| rating | 7 |
| reviewer | Jose Nazario |
| ISBN | 0201799405 |
| summary | A tour of large-scale development projects from code to organization |
A few books are tackling this subject, including Coder to Developer and Programming Language Pragmatics. These books don't teach you much about a particular language in the way that an introductory text would. Instead, you grow as a skilled developer by studying them and learning from them. That's one of the key things that people are talking about lately, that to be a strong developer requires more than a working knowledge of a language. It requires a familiarity with the strengths, weaknesses, and core features of a language and the base libraries to be efficient.
Code Reading: The Open Source Perspective is one of these books in this small but growing library. In it, Diomidis Spinellis takes you through a large body of code and focuses on several languages, techniques, and facets of development that differentiate strong developers from weak ones. What I like about this book is how much it covers, how practical the information is, and how much Spinellis teaches you. You wont learn a language, which is the complaint of some people who read this book, but if you know one or two you'll be a better programmer.
Perhaps one of the most telling things about the book is that it draws heavily from NetBSD source code, and features over 600 examples to make the point. Examples are often annotated using NetBSD as a reference. This makes sense, because NetBSD is a large project that's relatively stable and mature. Everything from how to define a C structure consistently and sanely to UML diagrams and build systems are covered, making this truly a developer's book. However, even Windows and Mac OS X developers will benefit, despite the BSD focus.
Chapter 1 introduces some of the basic tenets of the book, namely that code is literature and should be read as such. All too often people only read code when they have a specific problem to solve or want to get an example of an API. Instead, if you read code frequently you'll always be learning things and improving your skills. Also, Spinellis discusses the lifecycle of code (including its genesis, maintenance, and reuse), which simply must be taken into account if code is to be good. Poorly skilled developers forget these things and just slap it together, never thinking ahead.
In Chapter 2, a number of concepts basic to any programming language are covered, including the basic flow-control units common to many languages. The book focuses on C, with additional coverage given using C++, Java, and a few other things thrown in for good measure. As such, these chapters -- in fact the whole book -- focuses on concepts common to these languages but absent in some other languages, like Scheme or LISP. One neat section is called "refactoring in the small." It illustrates the real value of the book nicely, in showing you various ways to organize your code and your thoughts for various effects. Oftentimes a book will only teach you one way (which doesn't always suit your needs), and Spinellis' examples do a nice job of escaping that trap, not just here but throughout the book.
Chapter 3, "Advanced C Data Types," focuses on some language-specific matters. These are pointers, structures, unions and dynamic memory allocation, things that most people who code in C may use but only some truly understand well. Again, a somewhat basic chapter, but useful nonetheless. Make sure you read it; chances are you'll learn a thing or two.
In Chapter 4, some basic data structures (vectors, matrices, stacks, queues, maps and hash tables, sets, lists, trees and graphs) are covered. This is an important chapter since it helps you see these structure in real-world use and also helps you understand when to chose one structure over another. While Knuth, CLRS, or other algorithms and data structures texts cover these, they often do so in isolation and at a theoretical level. While their coverage is short, it's to the point and usable by anyone with a modest understanding of C.
Chapter 5, "Advanced Control Flow," the last chapter that deals with actual programming information, is another useful one. Again, short but to the point, this chapter covers things like recursion, exceptions, parallelism, and signals, all topics that have warranted their own books (or major sections in other books) but which are covered in a single chapter here. Still, seeing them side-by-side and in the context of each other and in real-world use provides some justification for the compact presentation.
The remaining chapters of the book go well beyond a normal programming book and focus on projects. These chapters complement the first bunch nicely by focusing on the organization of your code and projects. Chapter 6 deals specifically with many of the commonly identified (but rarely taught) things like design techniques, project organization, build processes, revision control, and testing. A number of things that aren't covered include defining and managing requirements for a release and their specifications, basics on how to use autoconf and automake, and instead rips through a whole slew of topics quite quickly.
Chapter 7 is sure to be controversial for some people: it covers "Coding Standards and Conventions." Some people seem to be big fans of the "if it feels good, do it" style of programming, and instead of writing sane, usable code, what they produce is buggy and messy. This chapter teaches you tried and tested methods of naming files, indentation (and how to do so consistently using your editor to help), formatting, naming conventions (for variables, functions, and classes), as well as standards and processes. The style and standards are (as you would expect) based on NetBSD, which differ slightly from GNU and Linux standards, as well as commonly found Windows practices. However, I think you'll agree that the style is readable with minimal effort, and that goal, coupled to consistency, is paramount in any standard.
Chapter 8 introduces you to documentation, including the use of man pages, Doxygen, revision histories, and the like. Also included are hints at using diagrams for added value. One thing I don't like about this chapter is the opening quote, which sets a bad precedent. It blithely suggests that bad documentation is better than none, which is highly questionable. Misleading docs can be worse than no docs at all, since someone without docs will have to dig through the code in front of them to understand it. Someone with bad docs will rely on the docs and wonder what's broken when things go awry.
Chapter 9 focuses on code architecture, such as class hierarchies, module organization, and even core features like frameworks to chose. This chapter covers a lot of material, and is, despite its size, simply too terse on many of these subjects. It serves as a decent introduction, but doesn't go very far in some places, considering the importance of the material. However, like much of the book, it's a good introduction to the topics at hand.
Chapter 10 also features a lot of good things to know. Granted, you could pick them all up with a lot of hard work and scouring for information, but it's easier to have them presented to you in a cohesive format. The chapter discusses code reading tools, things that you use to help you dig around a large body of code. One you get over a few source files, even if you have well-organized code and interfaces, many changes can require that you inspect the data path. You can do this manually, or you can be assisted with tools. Tools like regular expressions, grep, your editor -- Spinellis shows you how to make use of all of them when you write code. A lot of tools I've never used (but have heard about) are featured, and their use is demonstrated, but of course many tools are simply ignored, focusing on popular ones that will work for most people.
Finally, all of the above is brought together in Chapter 11, "A Complete Example." A small tour of a large, complex piece of code is taken (34,000 lines of Java) as the author makes changes. It's unfortunately in Java, when so much of the book focused on C (why couldn't they have been consistent examples?), but it works. The example itself could have covered a few more things, such as a proper JUnit example, but overall I'm pleased with it.
Overall, Code Reading: The Open Source Perspective is ambitious and worthwhile, both as a complement to a bookshelf of study that includes The Practice of Programming and Design Patterns, and to someone who is growing tired of books on learning a language. At times it feels like the author promised more than he wound up delivering, but it serves as an introduction to a large number of topics. You wont learn a language, and you wont be able to get as much out of the book if you don't engage it with practice, but it's a useful book to get started on the road from being someone who knows a language or two to someone who is a developer, ready to contribute to a team and work on large projects. Never underestimate the skills required to be a good developer, because they go well beyond knowing how to use a language.
You can purchase Code Reading: The Open Source Perspective from bn.com. Slashdot welcomes readers' book reviews -- to see your own review here, read the book review guidelines, then visit the submission page.
Consistency and good comments (Score:4, Insightful)
Very true. (Score:3, Insightful)
comments (Score:5, Insightful)
Comments (Score:5, Insightful)
If you started programming, you either chose to comment a lot, or not at all. "A lot", because you were never sure what your code was doing, and always needed the reference. Or "not at all", because you could make sense of the code very well.
Then you start your first big project. For the big commenter, he realizes after getting quite a bit of work done that a lot of time was "wasted" on comments. ("// This line increments the 'i' variable by 1".) Further, these comments seem way too obvious. For the non commenter, they get lost easily and wish they commented more.
So it goes in the opposite direction from when it started. The big commenter comments way less, and the non commenter comments way more.
Then it repeats. Eventually the programmer gets the happy medium of the right amount of comments.
This has been my experience, in my own code, and checking other people's code. Thoughts?
Re:I don't understand (Score:4, Insightful)
Yes. Getting it done right.
Re:comments (Score:5, Insightful)
I suppose it also holds that once you have surpassed the threshold of super-duper quality commenting, you get to the point of such awesome code that it documents itself, so you come full circle.
Re:Very true. (Score:5, Insightful)
I believe that what you are trying to say is that: (Score:4, Insightful)
I guess that I am just kind of average
Cheers,
Adolfo
Use comments only when needed (Score:5, Insightful)
Coding style (Score:5, Insightful)
Most critical is managing complexity. Large, complex functions are bad - they have more bugs, they are harder to maintain, harder to bug fix (a change has more likelyhood of breaking something else). If a function has grown beyond a hundred lines of (real) code, it is almost certainly too large. If it has more than 4 levels of nesting, it is too large.
Comments also matter. It's easy to code a couple of thousand lines of fresh code over a weekend if you get in the groove. It is almost impossible to unpick it one year later if you didn't comment it as you go.
Variable and function names should be expressive. No single letter variable names! No obscure combinations of letters like words with no vowels (fnct could be function or function control, or even Function Numerical Constant Type). And personally I find that reverse Hungarian notation can be more trouble than it's worth. puiAnnoying!
Build in automatic checks on everything. If a pointer to a function should never be null, check it and stop if it is. If a variable should only have values 1 -> maxIterations, then check it. If you (or anyone else) ever breaks that assumption, the code will flag it for you.
Beyond that, nothing beats good design, especially designs where extending the original work is easy. So many designs end up as tangle knots of conflicts because they ended up trying to solve problems that the original code base never envisaged.
Cheers,
Toby Haynes
Re:Cookie-cutter book? (Score:1, Insightful)
Re:comments (Score:3, Insightful)
Understanding the value of good code is one thing, but insulating your developers from top-down pressure and unreasonable deadlines which force them to "slap it together" allows programmers to prosper.
If your shop is producing crap code it's because your management is crap.
language bias detected (Score:4, Insightful)
Hmmm. What concepts, particularly what basic flow control concepts, are present in C, C++, or Java yet absent in Scheme or Lisp?
Re:Use comments only when needed (Score:4, Insightful)
I do beleive you can judge a programmer by the quality and quantity of comments.. A good programmer comments only when the code NEEDS commenting. No more, no less.
comments (Score:5, Insightful)
If the expression itself requires a comment, then it is not being expressed clearly enough. It should be rewritten.
If the expression is clear, but does not make sense in the context, appears suboptimal, or otherwise thwarts the reader's expectations, THEN I'll comment.
Real world project comments...
The art of code (Score:3, Insightful)
The open source angle is that the code will be viewed by many people and thus there is a greater detail to presentation, it's a form of ego stroking and seems to work quite well.
I do code reviews all the time and I can tell a novice developer from someone who has done it for a while, it's a hard thing to explain, it's like a difference between good and bad art. And just like with art, you can have decent artists and you can have great artists with very little in-between. Go figure
Re:Use comments only when needed (Score:5, Insightful)
Bad docs better than none (Score:2, Insightful)
Re:Code format (Score:4, Insightful)
I'll go one more step though. It's about white space. You can almost always recognize a good programmer by how clean the code looks because of proper use of white space. If the code is all crammed together and cluttered looking then you know that programmer sucks. White space does not make your code slower guys!
Note that I said this is a way to recognize a good programmers. Often experience plays a role but I see a ton of fairly experienced programmers that write ass crappy code.
I see a lot of people saying comments are also a sign but I have to disagree. Well written code is easy to read and figure out. I would much rather have nicely written code than comments. (Note that it is my job to fix other people's code so I have a lot of experience with this)
Re:language bias detected (Score:5, Insightful)
The claim that something is missing would be more compelling if they weren't "missing" it on purpose, and the trend wasn't swinging in the dynamically-typed (or, as I think of it, "value typed" as opposed to "variable typed"; whatever you do it's wrong to call it "weakly typed") language's favor anyhow.
(Variable-based-typing's only hope is that the type-inferencing languages penetrate into the mainstream before the recoginition that variable-based-typing isn't free does, that being the fundamental misconception keeping it afloat. (Once you ack. the obvious point that it is not free, and is in fact quite expensive, both in actual effort and in massively underestimated opportunity costs, you are suddenly able to consider it in terms of costs and benefits, and the cost/benefit analysis generally does not work out in its favor when done dispassionately, though there are exceptions.))
Re:language bias detected (Score:2, Insightful)
Off the top of my head, I can't think of any major flow control mechanisms missing from native Lisp. If they exist, I'm pretty sure there was a good reason that they don't exist in Lisp.
Re:Coding style (Score:4, Insightful)
Just to add some more to what you are stating. I've come to the realization that I must determine the final size of a project before starting. If, for instance, a program starts out as a simple Perl script for parsing an input file and later ends with a request for a GUI to be added and additional functionality I'm better off starting over and rethinking the final design then just pasting on the necessary changes to meet the new requirements. Otherwise, the project, although still small and maintainable over a week or two is complete chaos when revisited in say a month or two.
Comments do matter, however; it does seem over commenting is just as much of a problem as no comments or under commenting. I have been handed projects from long gone developers that have had more comments than code. While it did give insight into what they were doing it became hard to find the code amongst all the comments, even with color coding turned on. It's an artistic poetry of having the right thing to say and saying it correctly. Which I am far from doing in this post.
The automatic checks on everything that you mention, exception handling and such, should be designed into the project from the start. Grafting it on after the fact is a nightmare and I have pity for anyone that is asked to do this and especially with code that is not theirs.
A good approach to design, I believe, trumps everything though. If you can hash out truly usable requiremets and implement a good personal software process and stick to it documenting as you go the end product always seems to turn out many notches above par even for small projects. However, none of this ever seems to occur where I work. Half baked requirements and a lack of time to properly design and implement seem to be the norm.
Re:Coding style (Score:5, Insightful)
The problem with hard fast rules like that is they're frequently not right. Take a state machine for example. A simple one with 6 or 7 states will go over 100 lines, and will go over 4 nestings. Heck, you'll take one up with the loop and one with the switch alone. You can break it into functions and hide some of the nesting in functions, but when doing that you frequently end up with functions that don't make a lot of sense by themselves.
A better rule than size IMHO is the one logical operation rule. A function should do one logical operation (read a file, write a file, run a state machine, calculate something, etc). They should contain all the logic needed to do that operation plus any debug and error handling that makes sense at that level of code. They should be broken up into subfunctions ONLY if those subfunctions themselves follow the logical operation rule, and only if that logical operation makes sense outside of the context of the higher function.
Take the state machine example. If it needs to wait on a semaphore before each iteration, the wait should be its own function- waiting on a semaphore is a logical operation. The logic for each state should NOT be separate functions, they are part of the state machine and make no sense without the whole of the machine for context. Breaking them out results in harder to read code, even if you do lose the nesting. But if in case RUNNING_MOTOR you issue a stop command to the motor that probably makes sense to be its own function- how you actually stop the motor isn't part of the core logic of the machine.
I guess my point is- lines of code isn't the enemy, some things are complex and need many lines to do. Nesting isn't the enemy, some things require many loops/ifs. The enemy is a lack of clear separation of functionality and lack of clear abstraction between parts. If you have separation and abstraction, it tends to hit the optimal readability. If you don't, it will fail either because you broke it up too much (too little context) or too little (too much context).
Re:Use comments only when needed (Score:5, Insightful)
But the rest of us work for a living. You know, for bosses who don't "Get It." =) We have to fight for the time to keep code clean, because that time could be spent adding features instead. It can be a hard battle.
When you're in that kind of environment, comments can save your life. Or at least your ass.
Re:Use comments only when needed (Score:4, Insightful)
Maintainance is the Iceburg.
It's really hard for me to nitpick spelling, but I can't help myself, so please forgive me...
A good first step in writing clean, maintainable code is to be self-aware. Many experienced programmers don't realize that they write crappy code. Honest code reviews can help, but most people don't take criticism well, and negative style comments are ignored.
(Of course, my code is perfect... :)
Indeed! (Score:2, Insightful)
As a young freshly trained programmer, you are walking around with a hammer, and a lot of things look like nails.
You think you are a badass because of the power and precision with which you hit the nails.
Then one day and you see you are building a house. And there are a lot of other people whose work is instrumental to getting the house built.
So after a while you start telling other people how to hit their nails, and before you know it, you are building entire tracts of homes.
Re:QA (Score:1, Insightful)
Re:Comments (Score:2, Insightful)
1.) The first time to comment is when you are doing something you know are not standard. Bitwise shifts to multiply, things you know are sub-optimal etc. Exceptional things that are not done how they shold be done, or are typically done.
2.) When you want to explain how a relatively large block of code is working, or an entire classes purposes. Explaining a method or a class. Or a block of code to give an idea of flow.
Another thing that I feel improves comment quality is to force them to be complete sentences. Try and keep the sentences brief and complete so that it clearly illustrates what you are trying to say without repeating. The "Do not Repeat Yourself" DRY principle applies to written communication as well as code.
If you always refer back to these simple rules you will generally have code that is easier to maintain and that the comments don't go out of date on as quickly. I really think you could write an entire book on commenting code and naming variables and organizing code flow. Good Luck and happy coding!
I will agree that developers go through phases in how and when they comment, but having someone lay out guidelines and telling you when to comment and giving you a few concerete examples makes a huge difference. For me its always about being a good leader and doing what I say. I have seen programmers come from mediocre/average just following a few simple "rules". Commenting is a huge part of it. Because if you can comment at an abstract/high level you can prove you know what the code should be doing. And if you write comments before you write the code....
Jeremy
Re:Use comments only when needed (Score:5, Insightful)
As for comments getting outdated- thats why you update comments when you update code. If you don't do that, you're a poor programmer. Changing the code and not the comment is doing half the job.
Objective-C (Score:3, Insightful)
Uh,why does plain old text fail sometimes? (Score:1, Insightful)
i++;
Bad documentation *is* better than none. (Score:1, Insightful)
If the code doesn't match the documentation, then you have found a bug! Either the documentation or the code is flawed: you need to revisit the actual requirements to determine which is the case. This may require revisiting the problem at it's source to determine the business, hardware, or safety requirements. When you find out the required behaviour, code it correctly, and then document it correctly!
If you blithely rely on either the code *OR* the documentation to be correct, you're being far too trusting...
Re:Coding style (Score:3, Insightful)
w/ local functions) and adds in auto nulled
pointers and auto bounds checking via templates
and auto memory leak checking on assignments (via
templates as well) such that those modes are on only as a compile time option you get the best of both worlds, error checking when you need it and when you are absolutely convinced that the code will work, you can turn it off and get C/Fortran
type performance..
-bloo
Re:Code format (Score:2, Insightful)
{
is better by far
{
because the braces 'belong' to
the following block of code
}
not the
{
preceeding guard statement
}
}
Sincerely,
An OFP (Old Fart Progammer)
Re:Code format (Score:5, Insightful)
this {
style {
of indention
}
}
}
You are a newbie.
No way! I have been coding for 30 years...
It makes more sense to code
if (test) {
statement1
} else {
statement2
}
because the eye can immediately see from the 'if' and 'else' statements alone that a block of conditional code follows. Having the braces on the same line also marks out the lines as special: flow control code. I find that
if (test)
{
statement1
}
else
{
statement2
}
simply adds pointless extra lines to code, with no gain in readability.
Comments: they are documentation in the source (Score:4, Insightful)
I've tried to work on projects where we developed new software as much as possible. However, taken all together I think I've probably spent many months of aggregate time reading other peoples code, modifying it, adding new features and fixing bugs. I hate doing this work, not only because of poorly designed software but because most software I've worked on is almost entirely undocumented (e.g., no comments and no external documentation).
Some posters have mentioned comments and documentation in this thread. But in my opinion, it has not been discussed in strong enough terms. For a long rant on this topic, see my essay Software and Documentation [bearcave.com]. I'll summarize some of the points I try to make in this essay here.
There were only a few people in this thread who wrote that they think that software source code is self documenting. This is a good sign. In the past this was a widely held view. Perhaps it is becoming less popular. Perhaps pigs are becoming airborne.
To those of you who wrote that your code is self documenting: you are simply lazy and unprofessional.
Sure I can understand what well written code does. But I cannot understand why it does what it does. I can show you three hundred lines of wavelet signal processing code. You can immediately understand what the code is doing. But you will have no clue what-so-ever about why it does what it does unless you understand the thinking behind the code. The same is true of any complex software.
Another problem is that even though I might understand what components do and perhaps even why they are doing what they do, getting an overall understanding of the architecture of a large application can be difficult and time consuming.
By not writing comments in your code and, for large applications, providing external documentation on the architecture, you are saving your time and effort, but forcing others to spend effort that you could have saved them.
Even if you have no consideration for anyone else who must maintain the application after you write it, comments will help you find bugs in your own code. Again and again I have found that when I explain my code in a comment I am forced to look over it again. In doing this I have found that the code does not do what I intended or that I left something out.
When it comes to documentation there is rarely enough. Even if you make an effort to document your code, when you are in the middle of it you will not document things that you find obvious. When you return later, these obvious issues will have been forgotten and are not obscure.
Documentation must be maintained along with the code. And it should be extended where it is incomplete or unclear. English (or what ever your language is): it's another kind of software.
Developers seem to fall into two camps: those who believe documentation is important and who do it and those who do not. I've managed software groups where I mentioned documentation in people's performace reviews and it still did not good. So far I have not been able to get someone who does not document to do it.
I have thought that perhaps one solution would be to hold code reviews where one of the major features that was looked at was understandability in the code. But I have not experimented enough to know if this will actually get people to document their software.
Literate programming not only involves writing well designed and well informed algorithms. It also includes writing documentation that explains these algorithms.
Re:Coding style (Score:1, Insightful)
I agree with that for most cases. My variables are usually very descriptive, as are the functions. However, for simple counters I find that using i or j or similar works quite well. After all, everybody understands a for loop with an i index -- calling it array_index_counter or some-such is (IMHO) pointless.
Obligatory quote (Score:5, Insightful)
"Programs should be written for people to read, and only incidentally for machines to execute."
Re:Use comments only when needed (Score:1, Insightful)
Re:Use comments only when needed (Score:5, Insightful)
For example a comment that says "we have to make exceptions for clients whose names start with A because sales promised them a price cut" is very useful when somebody is scratching their head asking why there is a goofy if statement sitting there.
Re:Comments need structure (Score:1, Insightful)
Re:Indentation (Score:3, Insightful)
Re:Consistency and good comments (Score:5, Insightful)
And oddly, you'll notice that a lot of the coders who do this know a large multitude of languages
This isn't odd at all. I do it myself. And I know why I do it too -- the language you use is inconsequential. If you "write" a script, you can probably use a host of languages to do the task. The key is knowing what you want to do.
Over the years I've sat and listened to many "debates" (arguments, really) about which language was better than another. I've always sat back and thought, "Who cares?" Once you can reach a point where you can visualise the solution (this includes pseudocoding it out, or at least listing what the program has to do at this point), selecting a language is irrelevant, other than considering what languages are available to you.
I'm not saying different languages don't have their strengths and weaknesses, and I'm espcially not saying they are all the same. What I am saying is that once you "write" what the program needs to do, use a programming language is as easy as literally looking up syntax and function names in a book.
This is also how proper language translators operate. They don't know entire languages, but they instead form exactly what they need to say before translating. New languages become second nature after repeated use, it's always just a matter of knowing what you want before hand.
Consistency, good comments, and short code (Score:4, Insightful)
I believe that language familiarity has little to nothing to do with being a good programmer. A more familiar programmer can program faster but programming principles remain the same across all languages.
Smaller, simpler code is inherently less likely to contain bugs, runs faster, and is easier to troubleshoot.
If programmer A develops 1000 lines of code per day and programmer B develops 10 lines of code per day and both programs do the same thing I will pick programmer B every time (normal lines of code, not contest entries with runon lines and things)
Re:comments (Score:1, Insightful)
That is, the younger, less mature programmers are commenting tons and actually documenting their work because their teachers stressed how truly important it is. This is really boring. As the programmer matures, the comments decrease but the QUALITY [kerneltrap.org] of the comments increase, and end up being quite novel to read.
Re:Use comments only when needed (Score:5, Insightful)
The attitude that commenting is only something to be done if something isn't obvious to YOU is totally wrong and results in poor quality.
The problem with not doing this, is if its not totally obvious WHY something is being done, it may get changed to something "better" which may break things. Perhaps that particularly ugly sort algorithm needs to be there because of extensive profiling done on the code. If that isn't spelled out, somebody may stroll along and think you were an idiot for obviously using the wrong sort and ruin the performance. For instance.
ALL code NEEDS commenting at ALL times.
I can always judge a programmer by the quality and quantity of the comments. A good programmer doesn't presume to know when the code NEEDS commenting based on his totally biased opinion. It always NEEDS it. A good programmer knows what to say to make things as clear as possible.
Re:Consistency and good comments (Score:3, Insightful)
If you have to explain what a function is to do, it has not been coded very well.
Commenting in Eyecandy, ERP Modules & Space Cr (Score:3, Insightful)
I also do a lot of other programming (ActionScript rich media and stuff). I don't do opening or other comments there that much.
Why that?
If a multimedia app doesn't work I get an e-mail or a call asking to check into it within the next 24 hrs. The customer is anoyed or says that this comes bad with the end-user. We talk a little, I et to work and fix it within the next 10 hrs.
If a ERP module doesn't do what it's supposed to, I get a call on my mobile, with the CEO at the other end telling me that he's losing 200 Euro an hour because order processing has gone haywire.
This is a good point to end all discussion wether commenting is good or bad. When you are debugging a piece of code that keeps 3 people breathing you shure as well want it to be well commented.
The Lockheed Software Group, the people who write code for the space shuttle and other things, take this to the all-out extreme. They write EVERYTHING in a sort of human readable meta code, meta-comment THAT and then tranfer that to real code. They've had 3 bugs in 25 years - so I've heard. One of them being a counter problem that once would have nearly locked down a com-dish on an orbiter and prevented it from following it's target on earth after having rotated a certain amount. Figure: A millisecond of timing error in their code has the orbiter off course by 3 miles. I hear their comment line/code line ratio is about 7 to 1.
So much for "overcommenting is unprofessional".
Re:Consistency and good comments (Score:5, Insightful)
Yeah but your function doesn't live in a vacuum does it? How about you write some lines up there at the top to put it in context for when I have to fix it next year.
Your Cubemate.
Re:Indeed! (Score:2, Insightful)
So after a while you start telling other people how to hit their nails, and before you know it, you are building entire tracts of homes.
But that isn't the end. Suddenly you find yourself hating the way everyone else hits those nails (just when someone starts to get good they leave) and the subsequent lack of quality* to which your name is attached. You come to realize that either you care about lots of houses with your name attached, or you care about the quality of each house with your name attached. It cannot be both.
Now you choose. Do it yourself and do it right; or just take all you can, while you can, and move on up the management ladder. What do you value?
* - see "Zen and the Art of Motorcycle Maintenance" by Pirsig
sdb
Re:Use comments only when needed (Score:1, Insightful)
Very true...but yet we all seem to be able to communicate with normal langauges without to much difficutly. If you and I both understand the programming language and the problem at hand..with a well thought out design then we should be able to code in such a way that we need mnimial english...or whatever language.
Not to mention if we both have different coding styles then the whole experience turns into a learning experience since we are both forced to read more code...and in my opinion reading a lot code is almost as important as writing a lot of code if you really want to become good at it.
Anyway I am not really disagreeing with you....I think that I am simply suggesting that development should be done closer to that "ideal" environment were all designs are well thought out and documented...I suspect you are talking more about maintenance and I also understand first hand how bad it is to maintain code that was not meant to be readable without comments...yuck!
Call everything by its right name (Score:4, Insightful)
The essence of literature is communication. I've been writing C and C++ for years, constantly fine-tuning and refining code and documentation, line by line, paragraph by paragraph. And how apropos to realize that the point is to express the thought so clearly and concisely that any reader (including yourself three weeks from now) will grasp it as close to immediately as possible.
That means you have to think clearly in order to code clearly. This matters more than almost anything else.
Too much documentation is just as bad as too little, since it obscures the intent of the code. How much is just enough? It takes years of thoughtful practice to know that.
Everyone is posting their favorite rules about coding standards. Most young programmers apply standards as rigid as they are incomplete. I have only two rules:
1) Call everything by its right name. Functions are verbs, variables are nouns. The name you give a object should express what it is or does, no more and no less, and be readable in English (or whatever your spoken language is). If you add something to a function that doesn't fit the function's name, it either belongs in a different function or else you misnamed the function in the first place. This takes constant review of your code, from a literary point of view.
2) Rules are made to be broken. All great writers unhesitatingly break the rules in order to communicate more clearly.
Languages are for communicating, and computer languages are no different. Keep that in mind at all times, and you'll become a wizard.
Re:Consistency and good comments (Score:3, Insightful)
But note that there's a whole other world out there, and be careful not to fall into the PHBism of assuming that anything you don't know about must be simple. On the software engineering side, for large-scale projects, the choice of languages is not at all inconsequential, and can affect maintainability, quality, and performance. We're not handed a pseudocode design that spells everything out, and we only have to translate it into the actual language syntax. A requirement may say such-and-such shall appear alphabetically. You know what the program "needs to do", but there are choices of sorting algorithms, and data structures/containers, that have different qualities, that should be evaluated and chosen deliberately for the task at hand.
reading rule of thumb (Score:2, Insightful)
Hence, simple algorithms will likely have no comments in the implementation.
More of the time, comments that "supplement" the code usually add to the confusion for most advance developers.
Re:Use comments only when needed (Score:5, Insightful)
Re:The art of code (Score:2, Insightful)
comments are overrated (Score:2, Insightful)
What good are great comments if the code doesn't work? Sure, comments matter, but all of the comments in the world aren't going to make buggy software run better. It will just make the next programmer understand how screwed up the original programmer was.
Re:Consistency and good comments (Score:5, Insightful)
But does it explain *why* ?
Re:Use comments only when needed (Score:5, Insightful)
Second rule: Nothing is easy.
I was in a talk the other day and someone was explaining his research. He used the words obvious and easy more times than I have fingers, just on the first slide!
Afterwards I took him to one side and explained to him that most things are obvious and easy when you have been working on them for 2 years. He agreed and re-worked his approach.
It is the same with code, it is never obvious nor easy if you are not familiar with it.
The code I write is clean, uses meaningful identifiers, remains conistent in both structure and layout (I try to be anal about it). However, going back to some code I wrote last year, I wouldn't have stood a chance of understanding it if it wasn't for the comment explaining the algorithm in the code. This isn't because it is bad code, but because it was complicated and doing intelligent tasks (I would guess complicated and intelligent tasks covers most code).
Comments are required and are useful for understanding code, providing a bigger picture. Good comments compliment well good code. This is the same for any language.
You can have bad comments, or too many comments, but if you follow the same set of basic rules for you comments that you do your code, things should be fine.
Re:Use comments only when needed (Score:2, Insightful)