Есть ли PHP-эквивалент тега резюме C #?

Question

Можно ли в любом случае предоставить сводную информацию текстовых редакторов во всплывающей подсказке для пользовательских функций / классов и т. Д., Которую они могут сделать для стандартных библиотек при кодировании?

В противном случае это стандартный способ выделить цель, требуемые параметры и т. Д. Для функции / класса в PHP.

Answer 1

Извлечение PHPDocumentor .

Примером может быть:

/**
 * Set the data
 *
 * @access public
 * @param string $field
 * @param mixed $value
 */
public function __set($field, $value)
{
  $this->_data[$field] = $value;
}

/**
 * Get the data
 *
 * @access public
 * @param string $field
 * @return mixed
 */
public function __get($field)
{
  return isset($this->_data[$field]) ? $this->_data[$field] : NULL;
}

В качестве пояснений к комментариям вы используете @access, чтобы показать видимостьметод (если, конечно, суммируемый код является методом), @param для отображения каждого параметра и @return для отображения типа возвращаемых данных.Существует множество различных тегов для документирования различных аспектов кода.

Answer 2

Вы можете использовать стандарт PHPDoc , чтобы ваша IDE давала подсказки, например, о функции.

Непосредственно перед объявлением функции у вас может быть:

/**
 * This is a DocBlock comment
 */
function foo(){
    //....
}

Я использовал его в Netbeans и могу сказать, что он работает довольно хорошо.