When documenting PHP code with PHPDoc or similar how do you state array name => value pairs?

Question

If I had a function and I currently was passing in the values all as strings and had it documented something like this:

/**
 * Sends mail using the built-in Swift Mailer component
 * @param string $from The email address who it's from
 * @param string $to The email address who we are sending it to
 * @param string $message The text-based message to send
 * @param string $html_msg The html-based message to send
 * @param string $from_name The name of the person/company it is from
 * @param string $to_name The name/company of the person who we are sending it to
 * @param string $reply_to The reply to email address
 * @return bool true or false if sending succeeded
 */

But instead wanted to pass all the below in a single array, how would I document each key correctly?

ilpaijin · Accepted Answer · 2014-12-07 16:12:38Z

2

You should declare the param as an array and, eventually you could describe some details inside a code tag. Something like:

/**
 * Sends mail using the built-in Swift Mailer component
 *
 * Example:
 * <code>
 *
 *    $expectedArray = array(
 *        'from' => 'value',
 *        'to'   => 'another value',
 *        ... 
 *    );
 *
 *    yourfunc($expectedArray)
 *
 * </code> 
 *
 * @param array $yourarray an array bla bla... 
 * @return bool true or false if sending succeeded
 */

answered Dec 7, 2014 at 16:12

ilpaijin

3,7152 gold badges25 silver badges26 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Sven van den Boogaart · Accepted Answer · 2014-12-07 16:04:29Z

0

$email->from = '[email protected]';
$email->to = '[email protected]';

etc

answered Dec 7, 2014 at 16:04

Sven van den Boogaart

12.4k22 gold badges95 silver badges181 bronze badges

Collectives™ on Stack Overflow

When documenting PHP code with PHPDoc or similar how do you state array name => value pairs?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related