[ybadragon]

I agree, comments in code are primarily a bad thing. I don't use comments in my code, however I do document the process the code follows, most of the time through a workflow diagram I create via draw.io or something similar.

[jon.kiparsky]

Yeah, diagrams can be useful. There are some good tools that will extract a lot of this sort of thing - dependencies etc. This can save a lot of time.

[depricated]

Nitewalkr, on 06 October 2016 - 12:22 PM, said:

@Dep: Moments later after you said "my weakness is documentation," instructor approached and asked me to pull out a five assignments from few weeks ago.

--snip--

Right.

And hey, saying that it's a weakness doesn't mean I'm necessarily bad at it, or dislike it. I'm not saying "hell with documentation!" It's just the area I feel weakest. Hell, with the new job and everything I've been documenting (as there was no IT shop at all there is no documentation whatsoever for anything, so I'm writing it all) - I may no longer be able to call it my weakest point.

[modi123_1]

Another weakness I throw out there is my ability to understand succinct variable names. For a given scope variables go a-z.. then if I need more a1-z1.. a2-z2.. etc. Pffssh If you need the crutch of wordy named variables then you can just geeet out of my code.

[NeoTifa]

You guys are all terrible. You need to comment your code.

[depricated]

Your recommendation has been reviewed, considered, and rejected. Comments are a sign of bad code. Sorry, not sorry.

I highly recommend checking out this book. It changed the way I write.

[Nitewalkr]

depricated, on 06 October 2016 - 07:26 PM, said:

Nitewalkr, on 06 October 2016 - 12:22 PM, said:

@Dep: Moments later after you said "my weakness is documentation," instructor approached and asked me to pull out a five assignments from few weeks ago.

--snip--

Right.

And hey, saying that it's a weakness doesn't mean I'm necessarily bad at it, or dislike it. I'm not saying "hell with documentation!" It's just the area I feel weakest. Hell, with the new job and everything I've been documenting (as there was no IT shop at all there is no documentation whatsoever for anything, so I'm writing it all) - I may no longer be able to call it my weakest point.

should've read the "--snip--" I did make it clear that I knew that you did not say anything of "hell with documentation," sort, It is just something that every programmer should learn to live with.

If you talk about the diagrams in terms of documentation, I have not done those in a long time! I should bring that in to practice so at least when the employer is reviewing my code, he will have something to make sense out of it.

I also did not know that commenting is a bad thing. =\

EDIT: and than there is NEO's post. Good one

This post has been edited by Nitewalkr: 06 October 2016 - 02:20 PM

[modi123_1]

I wouldn't say commenting is a bad thing, but more of a balancing act. Bad comments that are useless are to be avoided in favor of making your code clear enough for folks to 'read'.. that's not to say comments should be avoided, but just used correctly.

[Salient]

Okay so today its the continued adventure in deciphering and fixing one hell of a complex report. Boss decided she would like some additional columns, ability to email, and you know, hey you have nothing better to do. Actually digging the whole thing to be honest.

Later am going to hit our own website dev for a few hours, see if I can't iron out a few CSS issues.

And then it's this weekend's podcast, for another site, a complete breakdown of the Paranormal Activity franchise, episode titled "Is Toby Simply a Dick" First of these I've done, but should be fun.

[jon.kiparsky]

modi123_1, on 06 October 2016 - 04:26 PM, said:

that's not to say comments should be avoided, but just used correctly.

Right. And for me - and most fans of the clean code style - that means "as little as possible"
For example, I will comment lines that are known to be uncovered by our tests, so people can be careful about them. Again, this is a code smell that we want to eliminate, but sometimes I'm not going to drop everything to get coverage on that line when I have a fix that needs to get done. Or I might comment something that is done in some non-obvious way, or for some non-obvious reason. Obviously, I'd prefer to simply make the code itself clearer, so the comment indicates that something needs to be done. (hence, it's a code smell)

[astonecipher]

Finished off the encryption stuff today, test on live environment, works swimmingly! The version of software I am using is a few weeks behind currently, so that will be updated tomorrow and on to the next feature addition.

[ArtificialSoldier]

I don't comment my code because when I come back to fix bugs I want there to still be a challenge.

[NeoTifa]

If you go look at my MATLAB snippets, you'll see how crazy I get with documentation.

Also, some c

	int p = 0; 				// number to which you wish to find primes
	int prev = 2;			// previous prime for determining pair
	int pairs = 0;			// number of prime pairs
	int sieve[MAX];			// array of numbers for sieve
	int i = 0;				// indexing var
	int n = 2;				// another indexing var

[NeoTifa]

[duplicate post sorry]

This post has been edited by NeoTifa: 06 October 2016 - 06:44 PM

[modi123_1]

So.. anyone evacuating the hurricane zones, or will we have a few D.I.C. boots on the ground for coverage?