Sloppy Code - thoughts
-
While we're on the subject of code reviews, what do you guys think about sloppy code that's not formatted well? I tend to not think I'm that anal retentive, but I admit the poindexter comes out when I see sloppy code that's not kept up to a proper margin, not indented decently, old commented code left in, etc. Oddly enough, the coders that write messy code tend to also have messy cars and homes. It's gross.
Jeremy Falcon
Readability and maintainability are at least as important as working code. Sloppy formatting costs time and money, and can lead to bugs. I don't even want to think about how much time I've had to spend re-formatting someone else's code to the point where I can read and fix it.
-
No I can deal with Hungarian notation as It was something that was considered good practice when I started with coding. An example of what I meant about silly naming convetions was..
private ClientPropertyForm m_RW_CPForm = null;
it took me a while to see that this was a supposed to be a read write instance of the client property form.
Every day, thousands of innocent plants are killed by vegetarians. Help end the violence EAT BACON
that's pretty gnarly, I agree. Another pet peeve I have - arbitrary abbreviations in a variable name. So, in your example: m_RW_ClientPropertyForm becomes m_RW_ClntPrpFrm.
Charlie Gilley Stuck in a dysfunctional matrix from which I must escape... "Where liberty dwells, there is my country." B. Franklin, 1783 “They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety.” BF, 1759
-
That's kind of a shallow analogy. It's like comparing Tesla's love for physics and women. You just cannot seek connections between ones physical appearance and mental capabilities.
Errr.. no. For years the military has used attention to excruciating detail in training to get soldiers aware of small things.. since ignoring small things can get you killed in combat. The attitude you bring to the table regarding how you handle details shows up in ALL we do. And good software is definitely about managing details well. I couldn't disagree with you more.
-
About what?
-
Probably. :(
-
While we're on the subject of code reviews, what do you guys think about sloppy code that's not formatted well? I tend to not think I'm that anal retentive, but I admit the poindexter comes out when I see sloppy code that's not kept up to a proper margin, not indented decently, old commented code left in, etc. Oddly enough, the coders that write messy code tend to also have messy cars and homes. It's gross.
Jeremy Falcon
Jeremy Falcon wrote:
what do you guys think about sloppy code that's not formatted well?
I don't think much of it. IMHO code should be formatted so that its intent is clear. While I prefer the K&R style, I'm not picky as long as the style is readable. /ravi
My new year resolution: 2048 x 1536 Home | Articles | My .NET bits | Freeware ravib(at)ravib(dot)com
-
However awful my code might be, at least it's properly formatted... :-) I agree with you; it's the same when I interview a developer that turns up looking like a homeless person: if you can't be bothered to take care of yourself, why would I believe that you'd be any different with your attitude to coding?
Use a tool for codeformatting, make sure to run it before you commit your code, or make your editor format your code. Codeformatting "by hand" is waste and should be eliminated.
-
Use a tool for codeformatting, make sure to run it before you commit your code, or make your editor format your code. Codeformatting "by hand" is waste and should be eliminated.
I do that to other people's code. :-)
-
I do that to other people's code. :-)
When you do that: - It seems in the source control that you modified the source code - It looks insulting for the other developer (the one who originally wrote the code) If you can't agree in a friendly conversation on one style of code, then you have more important problems to tackle in the team.
Make it simple, as simple as possible, but not simpler.
-
It's so easy to format your code properly... Ctrl + K, Ctrl + D (in Visual Studio anyway). It doesn't delete white spaces, but it does quite a bit for you. I'm amazed at how much badly formatted code I still see! And in my experience if the code is poorly formatted it's poorly written. Comments are as bad, or worse...
// Create a new person
Person p = new Person();NO, REALLY!? Arghhh! And I actually see those kinds of comments... Another thing I can't stand is copy-paste programming. And much too often it's way too obvious. The following is some production code I've had the 'pleasure' of working with (it was an obvious comment that was copy-pasted, but not edited with the code).
// Save the customer
product.Save();I looked at it and screamed in disgust "OH LORD, WHY DO YOU HATE ME SO!? :(( "
public class SanderRossel : Lazy<Person>
{
public void DoWork()
{
throw new NotSupportedException();
}
} -
When you do that: - It seems in the source control that you modified the source code - It looks insulting for the other developer (the one who originally wrote the code) If you can't agree in a friendly conversation on one style of code, then you have more important problems to tackle in the team.
Make it simple, as simple as possible, but not simpler.
Adam Tibi wrote:
It seems in the source control that you modified the source code
Indeed.
Adam Tibi wrote:
It looks insulting for the other developer (the one who originally wrote the code)
Then they should have done it right the first time. Seriously, if you're insulted because I tell you to format the code according to our agreed upon standards, then you're working in the wrong place.
-
While we're on the subject of code reviews, what do you guys think about sloppy code that's not formatted well? I tend to not think I'm that anal retentive, but I admit the poindexter comes out when I see sloppy code that's not kept up to a proper margin, not indented decently, old commented code left in, etc. Oddly enough, the coders that write messy code tend to also have messy cars and homes. It's gross.
Jeremy Falcon
-
Have you ever seen pictures of Einstein's office?
If you think 'goto' is evil, try writing an Assembly program without JMP.
Touché!
Jeremy Falcon
