@param tag alignment in php code sniffer

XMen picture XMen · Jan 18, 2011 · Viewed 7k times · Source

I am using php code sniffer for a function, i want to add @param tag but it is giving me alignment error of first and second param.

/**
 * for generating thumbnail 
 *
 * @param int    $minSize    an integer to size of thumbnail
 * @param string $sourceUrl  the string to source url 
 *
 * @return int the integer 
 */

function imgThumbs($minSize, $sourceUrl)
{   
}

please suggest, what is the problem why it is not showing , first and second are not aligned.

Answer

rik picture rik · Jan 18, 2011

Expected 1 space after the longest variable name

In your code the longest variable name $sourceUrl is followed by 2 spaces.

Edit: Here is how it should work (at least this error should disappear). I used dots for spaces at the important places.

/**
 * for generating thumbnail 
 *
 * @param.int....$minSize...an integer to size of thumbnail
 * @param.string.$sourceUrl.the string to source url 
 *
 * @return int the integer 
 */