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タグを使用するとよいでしょう。 @usesタグが

はそれが言うようになります（グローバル変数として、ページ、クラス、関数、定義、メソッド、変数）任意の要素を文書化するために使用することができる

：説明から、使用されているアイテムにバックリンクを作成しようとするため、ドキュメンテーションはそれを使用する関数/メソッドを示すことができます。

Answer 2

1つの方法は依存性注入を使用することです。これを注入関数/パラメータに記録することができます。もう1つの方法は、defineのdocblockの定数を文書化することです。これは、参照されるソリューションです。phpdoc: What's the proper way to document a constant