Commenting in such a way that a document generator can parse your
code is a good thing. I use VisDoc on OSX and it save a great deal of
time.
On Aug 23, 2006, at 2:45 PM, Mike Keesey wrote:
-----Original Message-----
From: [EMAIL PROTECTED] [mailto:flashcoders-
[EMAIL PROTECTED] On Behalf Of Steven Sacks | BLITZ
Sent: Wednesday, August 23, 2006 11:19 AM
To: Flashcoders mailing list
Subject: RE: [Flashcoders] Flash/Actionscript Coding conventions
Putting a block comment before a function is standard
All standards are is somebody's way of saying "I code like this
and so
should you."
Fair enough; it is *a* standard. But it is widely used, informative,
and, perhaps most importantly, there is software out there that can
automatically generate documentation from it.
And by the way, nobody reads those documents anyway.
I do. It's far easier to read one sentence of English than scan ten
lines of cryptic code.
//////////////////////////////////
// This is much better commenting
// It's easier to read than all those asterisks
// IMNSHO
/////////////////////////////////
Oh I used about 6 asterisks in my example. I don't like huge lines of
them, either.
--
Mike Keesey
_______________________________________________
[email protected]
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
_______________________________________________
[email protected]
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
