PHPDoc inline {@link} (и Netbeans) - PullRequest
       24

PHPDoc inline {@link} (и Netbeans)

5 голосов
/ 08 октября 2011

Возможно, я не совсем понимаю, но я пытаюсь получить встроенный тег PHPDoc {@link} для ссылки на другой метод в классе ( рассматриваемый докблок предназначен для метода "сокращенного псевдонима" )

На самом деле я ничего не сгенерировал для документации, но {@link} отображается в виде простого текста в дескрипторе метода NetBeans. Я делаю что-то неправильно синтаксически (, если я скомпилирую документацию, будет ли это работать? ) или просто NetBeans не может поддерживать встроенный {@link}?

Например:

class MyClass
{

    /**
     * Shorthand alias for {@link MyClass::method()}
     *
     * @param mixed $foo
     * @param mixed $bar
     * @return mixed
     */
    public function __invoke($foo, $bar)
    {
        return $this->method($foo, $bar);
    }

    /**
     * Does stuff with $foo and $bar
     *
     * @param mixed $foo
     * @param mixed $bar
     * @return mixed
     */
    public function method($foo, $bar)
    {
        // ...
    }

}

1 Ответ

4 голосов
/ 08 октября 2011

Скомпилируйте документацию, тогда она должна работать, иначе PHPDoc выдаст сообщение об ошибке, сообщающее вам больше.

Netbeans может не поддерживает все функции PHPDoc, вы также можете попробовать @see.

...