Aptana 3 ScriptDoc - @Return не работает в Code Assist - PullRequest
Новая
       1

Aptana 3 ScriptDoc - @Return не работает в Code Assist

1 голос
/ 01 сентября 2011

Я нашел этот вопрос, на который был дан ответ, но он не решил мою проблему: Aptana Scriptdoc не отображается в Code Assist

Использование PHP-эквивалента их примера ... 

/**
 * Gets the current foo
 * @param {String} $fooId The unique identifier for the foo.
 * @return {Object} Returns the current foo. 
 */
public function getFoo($fooId) {
    return $bar[$fooId];
}

Однако предоставленная документация выглядит следующим образом (включая дополнительные конечные скобки): 

getFoo($fooId)
Gets the current foo

@param String $fooId The unique identifier for the foo.
@return Object}
Resolved return types: Object}

Пожалуйста, дайте мне знать, что я делаю неправильно.

Спасибо!

1 Ответ

2 голосов
/ 03 сентября 2011

Тип @return не должен быть заключен в фигурные скобки.

Ваш документ должен выглядеть следующим образом: 

/**
 * Gets the current foo
 * @param String $fooId The unique identifier for the foo.
 * @return Object Returns the current foo. 
 */
public function getFoo($fooId) {
    return $bar[$fooId];
}

Синтаксический анализ возвращаемого типа следует за PHPDoc @правила возврата .

Это также означает, что вы можете иметь смешанный тип возврата, который даст вам подсказки по коду из нескольких типов.

Например: 

/**
 * @return MyClass|PDO doc doc doc 
 */

Приветствия

...