Old/Zend Studio/4

PHPDocumentor の日本語対応

PHPDocumentor と Zend Studio の連携

PHPDocumentor は PHPDoc 形式で記述されたコメントを元に、PHP ソースコードのドキュメントを HTML 形式などで作成する便利なツールです。 Zend Studio 4.0 では PHPDocumentor を同梱しており、ZDE の[メニュー]−＞[ツール]−＞[PHPDocumentor]を選択して、ドキュメント作成ウィザードを実行できます。
PHPDocumentor 本家のページ

制限事項

しかし、PHPDocumentor は日本語環境に対応されておらず、標準の状態では、PHPDoc 形式でコメントが記述されていても、作成したドキュメントが文字化けしてしまう場合があります。さらに、同様の問題により、PHPDocumentor との連携には、次の制限事項があります。

• PHPDocumentor ウィザードでは、デフォルトパッケージ名、デフォルトカテゴリ名、カスタムタグで日本語を指定できません。
• PDF出力は日本語に対応しておりません。

PHPDocumentor と Zend Studio の連携の日本語対応方法

ただし、Zend Studio 4.0 日本語版では一定の手順を行うことにより、ソースコードの日本語への対応、文書タイトル名の日本語の対応を行うことができます。次のセクションでは、それらの方法を解説しています。

ドキュメントの日本語コードへの対応方法

この処理は、ドキュメントを作成する前に行ってください。

ドキュメントを作成するソースコードの文字コードにより、Zend Studio クライアントインストールフォルダ下の

/bin/phpdocumentor/phpDocumentor/Converters

フォルダを、インストール CD-ROM にある次のフォルダに置き換えます。

文書タイトル名の日本語コードへの対応方法

この処理は、ドキュメントを作成した後に行ってください。

ドキュメントを作成したフォルダにて、文書タイトルが入っているファイルをエンコードします。文字コード変換機能のあるテキストエディタ、コンバータなどを使用して、下記のファイル(すべてあるとは限りません)をソースの文字コードと同じ文字コードにエンコードします。

[ドキュメント作成フォルダ]/blank.html
[ドキュメント作成フォルダ]/index.html
[ドキュメント作成フォルダ]/li_[パッケージ名].html

これらのファイルが出力された時点での文字コードは、Windows ではシフトJIS、MacOSX ではUTF-8、Linux では日本語EUCとなっているのが一般的です。これらがソースの文字コードと同じ場合はこの処理は必要ありません。

テンプレート説明文の日本語化

ZDE はテンプレート機能を提供していますが、インストール直後の状態では説明文が英語表記になっています。そのままでも使用に支障はありませんが、日本語化すると次のメリットがあります。

• ソースコードへのテンプレート挿入時の TIP ヘルプが日本語で表示されます。
• カスタマイズ画面でテンプレート一覧の説明文が日本語で表示されます。

テンプレートの説明文を日本語化するには下記の処理を行ってください。

1. インストール後、Zend Development Environment を一度起動した後、終了します。
   　
2. 各プラットフォームで、個人の ZDE 設定ファイルが格納されるというディレクトリが作成されますので、確認してください。
   　(例)

   Linux (ユーザ:root) : /root/ZDE
   Mac OSX (ユーザ:root) : /private/var/root/ZDE
   Windows (ユーザ:Administrator) : C:\Documents and Settings\Administrator\ZDE

   　
3. このディレクトリ内の config_4.0/templates に、インストール CD-ROM にある、次のフォルダに存在する差分ファイルを上書きします。

   ExtensionFiles/Templates

   　
4. Zend Development Environment を起動します。

この処理を行うと、ユーザによって追加、編集されたテンプレートは無効になりますので、必ずインストール直後に行ってください。

サーバソースの文字コード変更

Zend Studio Server の GUI の文字コード

Zend Studio サーバ日本語版は日本語コードが EUC-JP で記述されていますので、php.ini ファイルで EUC-JP を使用する設定にする必要があります。
　(例)

default_charset = "EUC-JP"

上記の設定を行うことにより、PHP のスクリプト実行結果のキャラクタセットが EUC であると Web ブラウザに解釈されます。

文字コードをShift_JISに変更する

Zend Studio サーバではShift_JISコードのGUIも提供しています。Shift_JIS コードを使用する場合は、下記の操作を行ってください。

1. Web サーバのドキュメントルート下にあるZendStudioServerフォルダに、インストール CD-ROM にある、次のフォルダに存在する差分ファイルを上書きします。

   ExtensionFiles/StudioServerGUI/ZendStudioServer_sjis

   　
2. php.ini ファイルも Shift_JISを使用する設定にします。
   　(例)

   default_charset = "Shift_JIS"

   　
3. さらに、次の場所も変更してください。

   zend_gui.language_charset = "Shift_JIS"

日本語 EUC のコードに戻す場合は次のフォルダの差分を上書きします。

ExtensionFiles/StudioServerGUI/ZendStudioServer_euc

それ以外の文字コードでは

それ以外のコードは提供しておりませんが、英語表記にて使用できます。php.ini の zend_gui.language の値を次のように en に変更して、Web サーバを再起動すると英語表記になります。

zend_gui.language = en