Есть ли эквивалент 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 и могу сказать, что она работает достаточно хорошо.