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

CodeCoachを実行する前、または実行した後に、CodeCoachによるアドバイスを調整できます。

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

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

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

keyword listは、カンマで区切られたアドバイスのキーワードのリストです。各アドバイス・タイプには、アドバイスに関連するキーワードがあります。リストには空白を使用しないでください。

プラグマが有効なのは、ソース・ファイルの最後までです。複数のファイルのアドバイスを無効にする場合は、IDEから設定することをお薦めします。

アドバイスの無効化

プラグマを使用してアドバイスを無効にするには、次のようにパターン化されたコードを使用します。


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

前述のコードによって、Vectorインスタンスの使用方法のアドバイス、およびmethodnameメソッドのすべてのローカル変数のアドバイスは、enable行に到達するまで無効になります。プラグマが無効化されたアドバイスは、再び有効に設定するか、ファイルの最後に到達するまで無効のままになります。

特定の行のみのアドバイスを無効にするには、次の行を使用します。

//@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の開始方法
CodeCoachの結果の操作
IDEからのCodeCoachアドバイスのカスタマイズ
コマンドラインからのCodeCoachの使用
CodeCoachキーワード

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