[TriggaMike]

I mean, I still walk through and describe things step by step as I'm doing them, like

//The following if checks blah
if(blah == this.blah)
    blah;

//If it isn't blah, throw an exception
else
    throw new BlahException();

I don't always do it like that, not for obvious things, but when it isn't obvious I'll go to that level of describing conditional statements and loops

Oh, and if you go through the Java API, you find comments everywhere. Sure their Javadoc is good, but their other comments are usually very vague and appear below code... it makes me want to throw something

This post has been edited by TriggaMike: 19 November 2009 - 12:30 PM

[Gorian]

I voted above, and then decided above and besided depending.

[EdwinNameless]

TriggaMike, on 19 Nov, 2009 - 11:28 AM, said:

//The following if checks blah
if(blah == this.blah)
    blah;

//If it isn't blah, throw an exception
else
    throw new BlahException();

I don't always do it like that, not for obvious things, but when it isn't obvious I'll go to that level of describing conditional statements and loops

Exactly, it depends *entirely* on the context.

Though, I must admit in this particular example, I wouldn't be so fond of breaking the if ... else with a comment. I'd rather have the second beside the else. Or nothing, especially if it only says “if not, throw exception”, since this is merely paraphrasing the code.

[TriggaMike]

I like to have a lot of blank lines in my code, even breaking up if/else statements like that.

[EdwinNameless]

TriggaMike, on 19 Nov, 2009 - 12:06 PM, said:

I like to have a lot of blank lines in my code, even breaking up if/else statements like that.

I really hope you won't get this the wrong way, but I'm guessing you're a young programmer.

Usually, inexperienced (nothing pejorative here) programmers like to leave lots of blank lines and overload with comments to clearly delimit the steps, whereas programmers who've been around for a quite while love to condense their code and leave fewer comments so that they see more LOCs at once.

[AdamSpeight2008]

I place my comment above the code it relates to.
I used to also add comments to the right of the code but don't now for this reason.
If the line of code is deleted it doesn't remove the comments
So I can write a pseudo code version of the code then fill it in at a later date,

[TriggaMike]

EdwinNameless, on 19 Nov, 2009 - 01:00 PM, said:

TriggaMike, on 19 Nov, 2009 - 12:06 PM, said:

I like to have a lot of blank lines in my code, even breaking up if/else statements like that.

I really hope you won't get this the wrong way, but I'm guessing you're a young programmer.

Usually, inexperienced (nothing pejorative here) programmers like to leave lots of blank lines and overload with comments to clearly delimit the steps, whereas programmers who've been around for a quite while love to condense their code and leave fewer comments so that they see more LOCs at once.

Condensed code is harder to read. I don't see why "experienced" programmers like to condense their code honestly. Yeah you can see more, but I can see plenty of code already on my screen, more than enough, and my IDE helps me anyway by providing a program outline. I haven't run into an issue where I'd said to myself "Gee I wish I could see more lines of code", it just doesn't happen. I have no problem scrolling through my code if I need to.

[KYA]

Anybody who does this:

int function(int math){int haha, my, code, is condensed; cout << "I can read more of it now!"; return fail;}

//or
int function(int num)
{int look, this, is retarded;
cout << "Wish i could read this!"; return fail;}

//as opposed to
int function (int num){
   int, wow, what, a, nice, function;
   cout << "KYA is indeed awesome!";
  return awesome;
}

Should immediately change careers.


Having that said, I truly despise horizontal scrolling.

This post has been edited by KYA: 20 November 2009 - 08:33 AM

[NeoTifa]

5thWall, on 19 Nov, 2009 - 11:55 AM, said:

My code is self documenting, I don't use comments.

Serious now: Most of my comments are JavaDoc style, so they all go above. Same with comments to clarify why I did something.

[BenignDesign]

Generally speaking, I put my comments above and to the side.

On rare occasions, I will put a line BELOW the code, but only to indicate where a certain behavior ceases and only in cases of extremely obfuscated code (which I am remarkably good at creating ).

[xclite]

Wtf is a comment?