phpDocumentor не понравятся теги @ param и @ return в уровне файлов докблок ...
Если вы выберете отдельный файл для их документирования, согласно ответу Mr-sk , вы можете использовать @ link , чтобы указать там, но это не будет сразу видно на странице документации вашего файла ... это будет просто гиперссылка, по которой вам нужно будет перейти, чтобы просмотреть информацию. Если вы хотите, чтобы какое-либо содержимое этого файла было видно на странице документации для вашего файла сценария, вы можете использовать встроенный тег {@ example} , чтобы указать на него, или даже только определенные строки в нем, например, {@ example / path / to / file 3 5} , чтобы отображались только строки с третьей по пятую.
В этом сценарии я бы, вероятно, решил просто объяснить вещи в длинном описании докблока на уровне файлов, поскольку на самом деле нет прямого способа пометить ваши параметры так, чтобы phpDocumentor распознал их как элементы кода в любом случае. Если бы любой из параметров, которые я использовал в своих описаниях, действительно был документированным элементом кода, который происходит где-то еще в коде, я бы использовал встроенный тег {@ link} , чтобы указывать на этот элемент кода.
Например, предположим, что есть некоторые константы, определенные в другом файле кода, и собственная документация этих элементов генерируется, когда этот другой файл анализируется. Если мое длинное описание, которое я записываю в докблок на уровне файла файла, содержащего только сценарий (например, ваше), говорит об этих константах в качестве параметров, то мое предложение может быть следующим:
If $POST['foo'] is set, its value should always be either {@link BAR_CONST} or {@link BAZ_CONST}.
Ссылки: