• We’re currently investigating an issue related to the forum theme and styling that is impacting page layout and visual formatting. The problem has been identified, and we are actively working on a resolution. There is no impact to user data or functionality, this is strictly a front-end display issue. We’ll post an update once the fix has been deployed. Thanks for your patience while we get this sorted.

Remember: Always Document Your Code

N

NiteWulf

Golden Member
And remember to write clear, definite, discernable comments:

Part present doesn't seem to make when collet is down empty, but it might.
Click to expand...

😕


Share your code comments.
 
Last edited:
no_comment.jpg
 
Nertz to you! Figure it out for yourself.

That's how I learned!

Damn kids and your "comment yer code". Whiners! The lot of ya!
 
I don't have the best memory and I don't feel like reading through the entire code to see what I'm doing... commenting in detail is the best thing I can do for myself. Sometimes it's 2+ lines. 😀

ie. just for one snippet
<!---
SET VALIDATED TO RECEIVED BECAUSE THESE CAME IN FROM IMPORT TABLE (NON VALIDATED after period) AND SHOULD BE RE-VALIDATED, RESET EMAIL SEND DATES.
THOSE STILL IN RECEIVED ARE PASSED-THRU WITH NO PROCESSING UNTIL SEND-OUT.
THOSE ACTUALLY VALIDATED NOW WILL BE SET VALIDATED FURTHER BELOW.
--->

Good thing too because they asked me to change the app up after 2 years not touching it.

Also have change logs with dates at the top of the code, also thanks to my memory.

Anyone else also use a ton of line breaks to separate sections of code so you can actually read / understand it better?
 
Last edited:
rh71 said:
I don't have the best memory and I don't feel like reading through the entire code to see what I'm doing... commenting in detail is the best thing I can do for myself. Sometimes it's 2+ lines. 😀
Click to expand...

The only problem with a lot of comments is that they tend to get stale over time. Code changes, and comments are left alone. Even unintentionally.

While I don't advocate removing comments altogether, I do encourage more use of the comments on the SCM check in to keep specific versions of code with the relevant comments.

Side Note: was reading about the linux kernal, Torvalds says to commit changes to the kernal, you ned 50-70 lines of comments (in the commit message) PER LINE of code changed.
 
If you're working with a team of other developers and you all will be using the code then you're just a dick if you don't comment. If you're a lone wolf and the Company you work for might screw you over you could be guaranteeing yourself many thousands of dollars in post-employment consulting fee's by not commenting.
 
Most of the comments I come across look like

//this is fucked

//i didn't write the following lines of code, don't blame me

///@@TODO
 
Alienwho said:
If you're working with a team of other developers and you all will be using the code then you're just a dick if you don't comment. If you're a lone wolf and the Company you work for might screw you over you could be guaranteeing yourself many thousands of dollars in post-employment consulting fee's by not commenting.
Click to expand...

Job security through obscurity? 🙂
 
Alienwho said:
If you're working with a team of other developers and you all will be using the code then you're just a dick if you don't comment. If you're a lone wolf and the Company you work for might screw you over you could be guaranteeing yourself many thousands of dollars in post-employment consulting fee's by not commenting.
Click to expand...

I've heard there are actually tools out there that will strip out all comments for you before you check in, but leave them in local files.

I can really only think of one use for such a tool.
 
Comments I have used recently:

//don't modify the following, I am initializing variables so the program does not crash
//counter
//another counter
//had to subtract 1 from the variable so the program would end properly
//Yes I am just reversing the positions in the array, makes the math easier.
 
Actual code in one of my applications that has never been released to public:


Code: 
//Decide what post action we want to do (new topic, reply, edit post, etc)
//This is one of the most horribly coded sections and will probably give you nightmares.  Scroll down at your own risk.  
//One day I'd like to find a better way for this

Worse part is, back in that time I never bothered indenting my code. Too bad though as the app itself actually did work very well and it was almost ready to go through some vigorous testing then release but the code is terrible. I was just learning php. It got me an A as my tech report in college, so that's all that counts, I guess. 😛
 
Red Squirrel said:
Worse part is, back in that time I never bothered indenting my code. Too bad though as the app itself actually did work very well and it was almost ready to go through some vigorous testing then release but the code is terrible. I was just learning php. It got me an A as my tech report in college, so that's all that counts, I guess. 😛
Click to expand...

I indent all my code, I *refuse* to review other code that is not indented. Lack of comments is one thing, lack of indenting... NO.
 
Possessed Freak said:
I indent all my code, I *refuse* to review other code that is not indented. Lack of comments is one thing, lack of indenting... NO.
Click to expand...

Yeah, now I'm the same way. I look at this code and I can't believe how terrible it is. D: Really I'd have to go through, indent it, and see if I can optimize it. I put so much time into that project I'd have to actually pick it back up again and release it. Though it may be easier to practically rewrite it from scratch and just go pick out parts of code for some of the logic.
 
You must log in or register to reply here.

TRENDING THREADS

Back
Top