hi guys
Something I've been thinking about for the last couple of days - what
extra information do you add to a class when you're writing it?
My headers always include
/**
* @filename : Main.as
* @version : Actionscript 3.0
* @author : Allandt Bik-Elliott
* @company : thereceptacle.co.uk
*/
and more recently a changelog
/**
* @changelog:
* 2009_09_03 : reason : change
*/
but I've been thinking about refreshing my practises.
I think I'll be using @version to track the class version number in
the header and revising my @version with @ASversion. I also think i
might need an @usage
do you add similar headers to each method (i've seen this done a few
times)? do you add any other information?
thanks
alz
_______________________________________________
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
