#php #documentation #phpdoc
#php #Документация #phpdoc
Вопрос:
Я использую phpDocumentor 2.5.0, и приведенные ниже теги не отображаются в документации (даже если они выполняются по одному за раз):
//None of these work
* @see MyClass::someFunction()
* @see MyClass::someFunction() that does something
* @uses MyClass::someFunction()
* @uses MyClass::someFunction() to do something
* @uses MyClass
* @uses /MyClass
* @uses /MyClass::someFunction()
Как мне заставить его добавить их в документацию?
Я не использую пространства имен.
Я запускаю phpDocumentor следующим образом:
phpdoc -d /home/development/code_to_document/ -t /home/development/documentation
Ответ №1:
Из какого docblock эти строки? До тех пор, пока это настоящий docblock:
/**
* @see MyClass::someFunction()
*/
и docblock находится в документируемом элементе кода (класс, метод, функция и т. Д.), Тогда я бы ожидал, что теги появятся, даже если ни MyClass, ни MyClass::someFunction() не были найдены в вашем проекте кода.
Если ваш тестовый код соответствует этим требованиям, возможно, вы обнаружили ошибку. Я предлагаю, по крайней мере, попробовать несколько разных шаблонов вывода, чтобы посмотреть, сохраняется ли поведение отсутствующего тега во всех из них.
Комментарии:
1. похоже, это ошибка. он замечает
@see
теги, но никогда не выводит класс и функцию. так что это пустая ссылка. Но если вы сделаете это, это «сработает»:@see MyClass::someFunction() MyClass::someFunction() does something
. обратите внимание, что я должен сделать это дважды.2. Это может быть связано с этой ошибкой — github.com/phpDocumentor/phpDocumentor2/issues /…