@param tag alignment in php code sniffer

Question

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.

`@param` should work fine with `Code_Sniffer`, whats the error exactly. — RobertPitt, Jan 18 '11 at 13:01
471 | ERROR | The variable names for parameters $minSize (1) and $sourceUrl | | (2) do not align 471 | ERROR | The comments for parameters $minSize (1) and $sourceUrl (2) do | | not align 471 | ERROR | Expected 1 space after the longest variable name — XMen, Jan 18 '11 at 13:02
remove the spaces from the variable and the description and relplace theb with tabs for alignment. — RobertPitt, Jan 18 '11 at 13:06
@Robert still do not align i m not getting, what i am missing ? — XMen, Jan 18 '11 at 13:13
@Robert i checked the link already and google other article but still not finding — XMen, Jan 18 '11 at 13:13
what happens if you remove the comments leaving the variables. — RobertPitt, Jan 18 '11 at 13:16
it is showing missing comments and other alignment error with name and comments — XMen, Jan 18 '11 at 13:19

rik · Accepted Answer · 2011-01-19T07:07:33.687

18

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 
 */

edited Jan 19 '11 at 07:07

answered Jan 18 '11 at 14:53

rik

8,592
1
26
21

its not working ,Please, can you give me format of two variable with written space and tab where to give , and one variable is longer than other ,Please write space don't give actual spaces , Please confirm your understanding – XMen Jan 19 '11 at 06:49

@param tag alignment in php code sniffer

1 Answers1