My Technical Notes

Thursday, 21 February 2013

Standard Section Comments

The following are my standard section comments.

For CSS (HEADINGS includes such things as h1, h2 ... h6:


/* HEADINGS   
----------------------------------------------------------*/

For Javascript, we have a start comment with a description of the object and we have a comment marking its end.


/* 
serverObj contains functions for calling web services
----------------------------------------------------------*/
var serverObj = {};

serverObj.myOperation = function(id) {
    ...
}

// more operations here

/*---- END OF: serverObj -----*/

At some point I may replace the JS START and End with regions

No comments: