Home / 5 / terms / 非推奨処理の対応方針

Index

• 非推奨警告の方法
  • コード上での警告
  • 実行時の警告

非推奨処理の対応方針

機能やメソッドについて、リファクタリングのために将来的に将来的に削除したい場合があります。

すぐに削除してしまうと、利用しているユーザーがアップデートを行った際に、予期せぬエラーが発生する可能性があります。 そのため、非推奨となる機能やメソッドについては、一定期間を設けて、利用者に対して警告を行うことで、対応を促すことができます。

これにより、開発者は将来的なアップデートや変更に備えることができ、ソフトウェアの長期的なメンテナンスやアップグレードが容易になります。

非推奨警告の方法

コード上での警告

クラスやメソッドのヘッダーコメントに @deprecated を記述します。
これにより、IDEが認識して警告を促してくれる場合があります。

/**
 * @deprecated 5.0.1 $this->BcBaser->isHome() を利用してください。5.1.0 で削除予定です。
 */

実行時の警告

BcUtil::triggerDeprecatedError() を利用することで、定型的なメッセージを実行時に出力します。
デバッグモードの場合のみ表示します。

BcUtil::triggerDeprecatedError(
    'ヘルパーメソッド：BcBaserHelper::isTop()', 
    '5.0.1', 
    '5.1.0', 
    '$this->BcBaser->isHome() を利用してください。'
);
// 出力文：ヘルパーメソッド：BcBaserHelper::isTop() は、バージョン 5.0.1 より非推奨となりました。バージョン 5.1.0 で削除される予定です。$this->BcBaser->isHome() を利用してください。