Friday, May 9, 2008

[ - Practices - ] - Commenting

This is a sample of a commenting system that I would like to adopt. Switching up my style after I realized that I'm quite a messy person. I am not too sure if the Contents Table was necessary. I considered it to be handy. I've asked one person about it, and he says that the Contents Table is overkill. It is a variant of a style I have seen before from another colleague of mine.



/*
=== INFORMATION =====================================================
Template // Actual Name
template.fla // Filename
Kevin Kelly - kk // Creator - Company Designation
May 8th 2008

Notation ------------------------------------------------------------
---------------------------------------------------------------------

Template with good notation and a Contents Table.
Pretty over the top.

---------------------------------------------------------------------

[INC] - Includes
[CLA] - Class Instanitions
[VAR] - Variables
[FUN] - Functions
[RUN] - Run Once or Run Time Functions

*/
// ===[INC]===================== Includes

// ===[CLA]===================== Class Instanitions

// ===[VAR]===================== Variables

// ===[FUN]===================== Functions

// ===[RUN]===================== Runtime or run once

// Just saying hello

trace("Saying Hello.");