重複の可能性:
phpDoc クラス定数のドキュメント
プロジェクト構成ファイルでいくつかの定数を定義しました。定数はすべてファイル内で適切にコメントされていますが、phpdocumentor は私がそれぞれに与えた説明を表示していません。定数の説明をドキュメントに表示する正しい方法はどれだろうか。これが私のコードです:
/**
* PROGRAM CONSTANTS
*
**/
// The directories will be stored as constants
/**
* PROGRAMHOME_DIR holds the absolute path to the home directory
**/
define( 'PROGRAMHOME_DIR', $_SERVER[ 'DOCUMENT_ROOT' ] . str_replace( array( '/', '\\' ), DIRECTORY_SEPARATOR, $base_dir ) );
/**
* PROGRAMIMAGES_DIR holds the absolute path to the images directory
**/
define( 'PROGRAMIMAGES_DIR', PROGRAMHOME_DIR . str_replace( array( '/', '\\' ), DIRECTORY_SEPARATOR, $images_dir ) );
/**
* PROGRAMLANG_DIR holds the absolute path to the languages directory
**/
define( 'PROGRAMLANG_DIR', PROGRAMHOME_DIR . str_replace( array( '/', '\\' ), DIRECTORY_SEPARATOR, $lang_dir ) );
/**
* PROGRAMPHP_DIR holds the absolute path to the php directory
**/
define( 'PROGRAMPHP_DIR', PROGRAMHOME_DIR . DIRECTORY_SEPARATOR . 'php' );
/**
* PROGRAMCLASS_DIR holds the absolute path to the class directory
**/
define( 'PROGRAMCLASS_DIR', PROGRAMHOME_DIR . DIRECTORY_SEPARATOR . 'class' );
/**
* PROGRAMREMOTE_URL holds the remote URL to the program
**/
define( 'PROGRAMREMOTE_URL', 'http://' . $_SERVER[ 'HTTP_HOST' ] . str_replace( array( '/', '\\' ), DIRECTORY_SEPARATOR, $base_dir ) );