Putting a block comment before a function is standard, though (Javadoc).
Putting one *inside* a function is awful, though, I agree.
/**
* This is a perfectly fine Javadoc comment
*
* @param bar some parameter
*/
public function foo(bar:Object):Void {
/* Using a block comment here is totally bogus. */
// Line comments, though, are great!
}
-----Original Message-----
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] On Behalf Of Steven
Sacks | BLITZ
Sent: Wednesday, August 23, 2006 10:21 AM
To: Flashcoders mailing list
Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions
I have an issue with coders who put block comments in the middle of
their code, such as:
/*******************
** SOME COMMENTS
******************/
function foo() {
trace("hello world");
}
Or even worse:
/*******************
** SOME COMMENTS
******************/
function foo() {
/* some comments inside the code */
trace("hello world");
}
People who comment like that are my bane and here is why. Commenting
like that in your code makes it completely impossible to easily and
completely comment out blocks of code using /* */ because they have
their */ inside their comments. Believe it or not, this is a very
important tool in debugging.
So, please do everyone a favor and only use block comments before and
after your code and use line comments // for all comments inside your
code. :)
Thanks,
Steven
_______________________________________________
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
_______________________________________________
Flashcoders@chattyfig.figleaf.com
To change your subscription options or search the archive:
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Brought to you by Fig Leaf Software
Premier Authorized Adobe Consulting and Training
http://www.figleaf.com
http://training.figleaf.com
