ファイル、クラスまたはメソッドに関するCodeCoachアドバイスのカスタマイズ

CodeCoachの実行前または実行後に、CodeCoachから提供されるアドバイスを調整できます。

プロジェクトに対してCodeCoachを実行する前に、ソース・コードに直接プラグマ(Oracle Java Compilerでのみ検出される特別な形式のコメント)を挿入して、個々のファイル、クラスまたはメソッドについてCodeCoachから提案されるアドバイスのカテゴリをカスタマイズできます。IDEでの設定は、ソース・コードに直接挿入した設定によりオーバーライドされます。

プラグマの通常の形式は、次のとおりです。

//@codecoach:[enable, disable, default] [keyword list]

キーワード・リストはアドバイス・キーワードのリストで、カンマで区切られます。アドバイス・タイプごとに、1つのキーワードが関連付けられています。リストには空白を含まないでください。

プラグマの有効範囲は、ソース・ファイルの最後までにかぎられます。複数ファイルに対するアドバイスを使用不可にする場合は、IDEから設定した方が簡単です。

アドバイスを使用不可に設定

プラグマを使用してアドバイスを使用不可にするには、次のようなコードを使用します。


//@codecoach:disable NVCT,LALL public void methodname () { // method body } //@codecoach:enable NVCT,LALL

このコードにより、enable行に達するまで、methodnameメソッドで、Vectorインスタンスの使用に関するアドバイスおよびすべてのローカル変数に関するアドバイスが使用不可になります。プラグマで使用不可に設定されたアドバイスは、もう一度使用可にするか、ファイルの終わりに達するまで使用できません。

特定の行のアドバイスのみを使用不可にする場合は、次の行を使用します。

//@codecoach:disable nextline

ただし、次の行にはその使用不可にしたアドバイスが表示されていることが重要です。空白行が間に挿入されている場合、使用不可は有効になりません。

アドバイスを使用可に設定

プラグマを使用してアドバイスを使用可にするには、次のようなコードを使用します。


//@codecoach:enable MALL public void methodname () { // method body } //@codecoach:default MALL

このコードでは、methodnameメソッドですべてのメソッド・アドバイスが使用可になり、その後プロジェクト・プロパティまたはコマンドラインで定義したデフォルトの動作に戻ります。

デフォルト・アドバイスの受入れ

プラグマを使用してデフォルト・アドバイスを受け取るには、次のようなコードを使用します。


//@codecoach:default ALL public void methodname () { // method body }

これでCodeCoachが、プロジェクト・プロパティまたはコマンドラインで定義されたデフォルトの動作に戻ります。


プロジェクトのCodeCoach処理
CodeCoachの開始方法
IDEからプロジェクトに関するCodeCoachアドバイスをカスタマイズ
コマンドラインからのCodeCoachの使用
CodeCoachキーワード

CodeCoachについて
CodeCoachアドバイスのカスタマイズについて
プラグマについて