chevalier
Mon, 28th Aug '06, 9:31am
Here are today's Neverwinter Nights forum highlights, collected by NWVault (http://nwvault.ign.com). Please take into account that these are only single parts of various threads and should not be taken out of context. Bear in mind also that the posts presented here are copied as-is, and that any bad spelling and grammar does not get corrected on our end.
<font size="3" face="Verdana, Arial" color="#cc6600">James Henley, Technical Designer</font>
Question from an Aspiring Scripter. (http://nwn.bioware.com//forums/viewpost.html?topic=493761&post=4283026&forum=47&highlight=)
<hr />I'd be tempted to say don't comment on scripts, short ones anyway. Better to read the code rather than the comments.<hr />Great advice...if you don't ever want to work in this industry, that is. http://forums.bioware.com/_commonext/images/smiles/icon_smile.gif
More:<hr />There goes my credibility on nwvault ^^.<hr />My apologies. I have a sarcastic sense of humor and mean no harm. http://forums.bioware.com/_commonext/images/smiles/icon_smile.gif
I'm in agreement with Sunjammer on this matter.
I'm of the mind to comment absolutely everything in order to minimize the time and effort of anybody else that ends up having to work in my code.
You can get away with only using header comments on something extremely short, but I still prefer to add comments every few lines at the bare minimum.
Good coding practices make life smoother for yourself and your team.
In regards to that script you posted, Xiphias, no, I do not consider it to be adequately commented. Self-explanatory to anybody familiar with the language, yes, but I habitually foolproof my own code.
I'd say "to each, their own," but some ways aren't as happily accepted in a team environment. http://forums.bioware.com/_commonext/images/smiles/icon_wink.gif
<font size="3" face="Verdana, Arial" color="#cc6600">James Henley, Technical Designer</font>
Question from an Aspiring Scripter. (http://nwn.bioware.com//forums/viewpost.html?topic=493761&post=4283026&forum=47&highlight=)
<hr />I'd be tempted to say don't comment on scripts, short ones anyway. Better to read the code rather than the comments.<hr />Great advice...if you don't ever want to work in this industry, that is. http://forums.bioware.com/_commonext/images/smiles/icon_smile.gif
More:<hr />There goes my credibility on nwvault ^^.<hr />My apologies. I have a sarcastic sense of humor and mean no harm. http://forums.bioware.com/_commonext/images/smiles/icon_smile.gif
I'm in agreement with Sunjammer on this matter.
I'm of the mind to comment absolutely everything in order to minimize the time and effort of anybody else that ends up having to work in my code.
You can get away with only using header comments on something extremely short, but I still prefer to add comments every few lines at the bare minimum.
Good coding practices make life smoother for yourself and your team.
In regards to that script you posted, Xiphias, no, I do not consider it to be adequately commented. Self-explanatory to anybody familiar with the language, yes, but I habitually foolproof my own code.
I'd say "to each, their own," but some ways aren't as happily accepted in a team environment. http://forums.bioware.com/_commonext/images/smiles/icon_wink.gif