php function comment

1/**
2 * This function compiles a message that tells you how great coffee is
3 *
4 * @param string  $compliment A nice word to describe coffee 
5 * @param integer $score      A score out of 10
6 */

1
2Notes can come in all sorts of shapes and sizes. They vary, and their uses are completely up to the person writing the code. However, I try to keep things consistent in my code that way it's easy for the next person to read. So something like this might help...
3
4<?php
5
6//======================================================================
7// CATEGORY LARGE FONT
8//======================================================================
9
10//-----------------------------------------------------
11// Sub-Category Smaller Font
12//-----------------------------------------------------
13
14/* Title Here Notice the First Letters are Capitalized */
15
16# Option 1
17# Option 2
18# Option 3
19
20/*
21 * This is a detailed explanation
22 * of something that should require
23 * several paragraphs of information.
24 */
25 
26// This is a single line quote.
27?>
28
29