October 13, 2009 at 9:03 pm

CSS File and Function Inventory

As with any software, an evaluation should be made of all the required functionality, a core set of functions created or agreed upon, and a standard way of interacting with UI elements created. Scripts should be stored in a central location and documented by a knowledgeable staff that is aware of what is available and what is needed.

A reference for a JavaScript function can be just like any other programming language. For instance, if there was a utility function to combine two strings together (not that someone would ever need such a thing), it might be documented as follows:

string myStringCombiner(string param1, string param2)
Purpose: combines two strings, returns a new string
Parameter Description
param1 Required. First string to concatenate to the second.
param2 Required. Second string to concatenate to the first.
Notes: Function is available by including base-functions.js.

Sorry, comments are closed at this time.

Back to top