CodeSweeper を使ったコード書式の保持

CodeSweeper の機能によって、コードを正しく書式設定する作業を自動化することができます。これは、さまざまな状況で非常に便利です。

複数の開発者に同じ設定を使わせて、簡単にコーディングスタイルを制定することができます。
ドキュメントを見直すときに、既存のプロジェクトのコード書式を簡単に削除することができます。
ビジュアル編集のためのデザインモードを有効にすると、ブラウズモードまたは編集モードへの切り替え時に書式設定ルールを適用するように CodeSweeper を設定することができます。

JRun Studio には、特定の種類の開発用に設定されたさまざまな CodeSweeper が含まれています。また、独自の CodeSweeper を作成したり、既存のものを編集したりすることもできます。インストールされる CodeSweeper には次のものがあります。

HTML\CFML -- ColdFusion アプリケーションおよび HTML 用
HTML -- HTML ページコード用に最適化
JSP (既定) -- JSP、HTML、および CFML タグのサブセット
WEB-XML -- ディスクリプタファイルの配置に使う Java\EJB コード
WDDX Sweeper -- WDDX 構文のみ
HTML Tidy － Allaire CodeSweeper の代わりに使うことができる、独立したオープンソースコード HTML の検査および書式ツール
My CodeSweeper -- テストと編集に使うことができる CodeSweeper

CodeSweeper の機能に関する記事については、Allaire 社の開発者用 Web サイトを参照してください。

CodeSweeper の実行

現在のドキュメントについて既定で実行するには、[ツール] > [CodeSweeper] メニューを開いて CodeSweeper を選択するか、またはツールツールバーの [CodeSweeper] ボタンをクリックします。CodeSweeper ボタンの隣りにある下矢印ボタンをクリックして、利用可能な CodeSweeper のリストから選択します。

既定の CodeSweeper を設定するには

[オプション] > [設定] > [CodeSweeper] を開きます。
リスト内の CodeSweeper エントリを強調表示し、[既定値に設定] ボタンをクリックします。
[OK] をクリックして変更内容を保存します。

デザインモードを終了した後、自動的に CodeSweeper を実行するには

[オプション] > [デザイン設定] で [デザインタブを無効にする (非表示)] オプションをクリアします。
デザインビューを空白のままにした場合に警告メッセージを表示するかどうかを選択します。
[デザインビューを終了するとき、CodeSweeper を適用する] ボタンをクリックします。
CodeSweeper を編集する場合は、[CodeSweeper の設定] ボタンをクリックします。

CodeSweeper の管理

新しい CodeSweeper を作成したり、既存の CodeSweeper を編集したり、必要に応じて削除したりすることができます。

新しい CodeSweeper を追加するには

[Allaire CodeSweepers] パネルの [新規プロファイル] ボタンをクリックします。
CodeSweeper 名を入力し、そのタイプを選択します。CodeSweeper のタイプは Allaire または HTML Tidy です。
[OK] をクリックしてリストに追加します。
新しい CodeSweeper の独自のプロファイルを作成するには、次の手順に従います。

CodeSweeper を編集するには

リスト内の CodeSweeper を強調表示し、[プロファイルを編集] ボタンをクリックします。
[一般設定] および [タグ固有の設定] を変更し、[OK] をクリックして新しいプロファイルを保存します。

CodeSweeper を削除するには、CodeSweeper を強調表示し、[プロファイルを削除] ボタンをクリックします。

Allaire CodeSweeper の設定

これらの設定は Allaire CodeSweeper のみに適用されます。HTML Tidy Codesweeper 設定については、次の節で説明します。

設定を開始するには、[オプション] > [設定] > [CodeSweeper] 画面を開きます。

一般設定

タグ、属性、およびイベント名の大文字と小文字の区別を設定します。ドキュメント内で検出されたとおりの大文字/小文字を維持するか、またはすべて大文字または小文字に変更するかのいずれかを選択することができます。大文字と小文字の区別のある JavaScript イベントハンドラのイベント名も、大文字と小文字を混在させて設定することができます。
属性値の引用符の書式を設定します。
[タグ間の余白をトリミングする] オプションは、コード生成ツールによって発生した余分なスペースを削除します。これは、既定で有効になります。必要に応じて、個々のタグについて、このオプションを有効のままにするか、または無効にすることをお勧めします。
CodeSweeper 実行時に警告が表示されないようにするには、["サイレントモード" で実行] を選択します。このオプションを使うと、無人状態で CodeSweeper を実行することができます。
CodeSweeper によって検出されたエラーを記録するには、[ログファイルにエラー情報を記述する] を選択します。ログファイルの特別な場所を指定することができます。

Allaire CodeSweeper では、タグ名内のコロン (:) が通常の文字として処理されるので、<xsl:thistag name="foo"/> のように、タグ内で XML ネーム空間の処理が可能です。

タグ固有の設定

Allaire CodeSweeper には、含まれている個々のタグにさまざまなオプションがあります。

これらの設定値はスペースからインデントまでを網羅しています。CodeSweeper を呼び出す際、選択したタグをそのままにしておくことができます。サーバベースのスクリプトコードの解析に問題が発生した場合は、[タグのフォーマットを保持する] オプションを有効にします。

ヒント : [ドキュメントからタグを外す] オプションは、コード生成ツールによって挿入された不要なタグを取り除くのに便利です。

タグのルールを設定するには

リストから CodeSweeper を選択します。
必要に応じて [一般設定] を編集します。
[タグ固有の設定] タブに切り替え、リスト内のタグ名を強調表示します。
リストの [他のすべてのタグ] エントリを選択すると、選択したルールは、ドキュメントで検出されたリスト内のすべてのタグに適用されます。
タグの設定値を編集します。
[タグを更新] をクリックし、そのタグの設定を保存します。

タグを追加し、書式設定ルールを適用するには

[タグ固有の設定] タブの [タグを追加] ボタンをクリックします。
タグ名を入力し、 [OK] をクリックします。
タグのルールを設定し、[タグを更新] をクリックして設定値を保存します。

タグを削除するには、タグを強調表示し、[タグを削除] ボタンをクリックします。

HTML Tidy の設定

HTML Tidy には、Allaire CodeSweeper に用意されている書式設定オプションだけでなく、行ラップ機能や、タグ、文字、およびドキュメントの変換機能、XML 処理などの便利な機能が多数あります。

HTML Tidy の作者の Web サイトは http://www.w3.org/People/Raggett/tidy/ です。[Allaire Default HTML Tidy Settings] 画面からこの Web サイトにアクセスすることができます。すべての HTML Tidy 設定値の詳細については、この Web サイトを参照してください。

独自の HTML Tidy プロファイルの作成は、Allaire CodeSweeper のプロファイルの作成とほとんど同じです。

HTML Tidy プロファイルを作成するには

[HTML Tidy CodeSweeper] ダイアログボックスの [新規プロファイル] をクリックします。
プロファイル名を入力します。
CodeSweeper の種類のドロップダウンリストから [HTML Tidy] を選択して [OK] をクリックします。
オプションの既定セットがあらかじめ選択されています。
リスト内の CodeSweeper を強調表示し、[プロファイルを編集] をクリックします。
必要に応じて設定を変更し、[OK] をクリックして新しいプロファイルを保存します。

HTML Tidy プロファイルを直接編集する必要がある場合は、JRun Studio の\Extensions\Codesweepers\ の .tdy ファイルを開きます。これはテキストファイルです。

HTML Tidy プロファイルを削除するには、Windows エクスプローラか、または Studio の [ファイル] タブから .tdy ファイルを削除します。

JRun Studio 入門
第 6 章 : ページの編集