Because we all love code comments

Comment Templates

/*******************************************************************************
* Title Here                                                                   *
*                                                                              *
* Optional description space                                                   *
*                                                                              *
* @author                                                                      *
* @version                                                                     *
* @date                                                                        *
* @license                                                                     *
*******************************************************************************/



/**
 *  Title Here 
 *
 * Optional description space
 *
 * @package 
 * @link    
 * @author   
 * @license 
 */



/*******************************************************************************
*                                                                              *
*                                                                              *
*                           Some cool comment here                             *
*                                                                              *
*                                                                              *
*******************************************************************************/


/*******************************************************************************
*********************        *****  *****      *** ** **************************
*********************        ***      ** ********* * ***************************
********************* ****** *** **** ** *********  ****************************
*********************        *** **** ** ********* * ***************************
*********************        ***      ***      *** ** **************************
********************************************************************************
*******************************************************************************/


/**
 * @name
 * @param
 * @return
 */

 /**
 *
 *  
 *
 * @param
 * @return
 */

 /**
 * TO DO: you should really be doing something.
 */


/*******************
*VARIABLES*        *
*         *  info  *
*   12    *        *
********************
* METHODS *        *
*         *  BOXES *
*    5    *        *
********************/

/**********
*VARIABLES*
*         *
*   12    *
**********/

/**********
* METHODS *
*         *
*    5    *
**********/

/******************************************
*             * @author                   *
*   Title     * @version                  *
*             * @licience                 *
******************************************/


/******************************************
*************** @author                   *
*****TITLE***** @version                  *
*************** @licience                 *
******************************************/

/******************************************
Method Name                               *
*                                         *
Additional comments here                  *
*                                         *
@param                                    *
*                                         *
@return                                   *
******************************************/

     *   **************************   *
      * * Beware                   * *
       *       Dangerous            *
       *               Code         * 
      * *                 Below    * *
     *   **************************   *