How should I properly document this code snippet:
// Define a collection of colors with methods
colors = {
// Define method for color red
"red" : function() {
// Do something...
}
// Define object for color black
"black" : {
// Add method for sub-color black-1
"black-1" : function() { /* Do something */ }
}
}
I am utilizing YUI Doc to generate documentation.
The following tags are at your disposal:
- @module
- @class
- @method
- @event
- @property