комментарии — при документировании PHP-кода с помощью PHPDoc или аналогичного, как вы указали имя массива = & gt; пары значений?

Question

комментарии — при документировании PHP-кода с помощью PHPDoc или аналогичного, как вы указали имя массива = & gt; пары значений?

Если бы у меня была функция, и я в настоящее время передавал значения в виде строк, и это было задокументировано примерно так:

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

Но вместо этого я хотел передать все перечисленное ниже в одном массиве, как бы я правильно задокументировал каждый ключ?

1

comments php phpdoc

Решение

Другие решения

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

так далее

0

Источник

Accepted Answer

Вы должны объявить параметр как массив и, в конце концов, вы можете описать некоторые детали внутри тега кода. Что-то вроде:

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

2