Non obvious parameter

2 messages Options
Embed this post
Permalink
Mathieu Suen-3

Non obvious parameter

Reply Threaded More More options
Print post
Permalink
Hi,

Here is some random feedback on the way method are document.
IMHO When implementing a method it should be quite obvious what to pass
in parameter or it should be implement in an other way.

In Zend I see a lot of comment like:

@param mixed $spec The column(s) and direction to order by

qWhat the hell is this strange obscure mixed parameter?
It could be:

array('col_name1', 'col_name2')
array('col_name1' => 'ASC', 'col_name2' => 'DESC')
array('col_name1', 'col_name2' => 'DESC')
'col_name1 ASC, col_name2 DESC'
'col_name1, col_name2 DESC'
array('ASC' => array( 'col_name2',  'col_name1'))
array('col_name1 ASC', 'col_name2 DESC')
...

Do you suggest me to flip the coin?

--
-- Mathieu Suen
--
Nicolas GREVET

Re: Non obvious parameter

Reply Threaded More More options
Print post
Permalink
Yeah, it has always been like this. In this kind of situation, all
you're left with is looking at the source code itself or crawling the
official doc for some answers... But when you're using an IDE like
NetBeans or Eclipse, it's a real pain...


Mathieu Suen a écrit :

> Hi,
>
> Here is some random feedback on the way method are document.
> IMHO When implementing a method it should be quite obvious what to
> pass in parameter or it should be implement in an other way.
>
> In Zend I see a lot of comment like:
>
> @param mixed $spec The column(s) and direction to order by
>
> qWhat the hell is this strange obscure mixed parameter?
> It could be:
>
> array('col_name1', 'col_name2')
> array('col_name1' => 'ASC', 'col_name2' => 'DESC')
> array('col_name1', 'col_name2' => 'DESC')
> 'col_name1 ASC, col_name2 DESC'
> 'col_name1, col_name2 DESC'
> array('ASC' => array( 'col_name2',  'col_name1'))
> array('col_name1 ASC', 'col_name2 DESC')
> ...
>
> Do you suggest me to flip the coin?
>