phpDoc способ перечислить, какие внешние константы использует класс?

Question

Есть ли лучший способ документировать, какие внешние константы используются классом PHP?

Например, у меня есть класс, который записывает данные в текстовый файл. Этот класс создает файл и помещает его в каталог. Путь к этому каталогу является константой APP_LOG_PATH. Как мне документировать свой код, чтобы кто-то мог быстро взглянуть на класс PHP и знать, что APP_LOG_PATH необходимо определить где-то в вызывающем коде. Что-то вроде:

/**
* Write to file
*
* @depends_on APP_LOG_PATH
* @param string The file name
* @param string The content to write
*/
static public function write_to_file($filename, $content){
    file_put_contents(APP_LOG_PATH . $filename, $content);
}

Answer 1

Вы можете рассмотреть возможность использования @ использует тег для него. Из описания:

Тег @uses может использоваться для документирования любого элемента (глобальная переменная, include, страница, класс, функция, определение, метод, переменная)

Далее говорится, что он попытается создать обратную ссылку на используемый элемент, чтобы в документации можно было увидеть, какие функции / методы будут его использовать.

Answer 2

Одним из способов было бы использование внедрения зависимостей, которое затем вы могли бы задокументировать в своей функции / параметре внедрения. Другим способом было бы документировать константу в docblock для определения, что является решением, на которое ссылается phpdoc: как правильно документировать константу