ObjectController Cleanup: Refining the Design

A place to discuss and present upcoming features for the SWG:ANH Server

Re: ObjectController Cleanup: Refining the Design

Postby apathy » July 15th, 2010, 12:02 am

Judge wrote:As a new coder i have never understood why people wouldn't document inline what each major block of code was doing, these comment lines just get thrown out by the compiler anyway, so no room is actually wasted.and when someone else goes to look, modify, or troubleshoot those comments and explanations can be a lifesaver, especially when there are so many lines of code to deal with. could anyone enlighten me as to why this wouldn't happen?


The road to hell is paved with good intentions. Most developers, particularly in a project that is made of people contributing in their free time, intend to do things like proper documentation but often find themselves short on time, or they mean to come back to it and forget, or any other number of reasons. By far the largest reason I imagine is that most people in these types of projects don't always come from a professional or academic background and therefore don't have these types of practices ingrained in them.

That's something we're making a conscious effort to do and that's the most that can be done.
Image
~ May the Source be with you ~
apathy
Retired SWG:ANH Staff
 
Posts: 57
Joined: July 16th, 2009, 12:36 am
SWG Official Server: Naritus

Re: ObjectController Cleanup: Refining the Design

Postby Judge » July 15th, 2010, 8:26 am

Thank you for the speedy reply. I wasn't trying to be a jackass, I just thought there might have been some reason that I didn't have a grasp for. As I said I'm still extremely green as a coder.
Judge
 
Posts: 14
Joined: July 14th, 2010, 9:00 am

Re: ObjectController Cleanup: Refining the Design

Postby apathy » July 15th, 2010, 9:26 am

Judge wrote:Thank you for the speedy reply. I wasn't trying to be a jackass, I just thought there might have been some reason that I didn't have a grasp for. As I said I'm still extremely green as a coder.


Not a problem! And no worries, I took it as an honest question because for all intensive purposes if you get yourself in the habit of documenting code as you write it then it really isn't such a drag. It's the getting yourself to that point where it's like second nature that can be the chore.
Image
~ May the Source be with you ~
apathy
Retired SWG:ANH Staff
 
Posts: 57
Joined: July 16th, 2009, 12:36 am
SWG Official Server: Naritus

Previous

Return to Feature Proposals

Who is online

Users browsing this forum: No registered users and 1 guest

cron