PHP/phpdocumentorについて の変更点


 *スタイルの変更 [#rc8b15ee]
 
 **どのようなスタイルがあるのか? [#d88a7112]
 見た目の一覧は、
 http://fro.blog.so-net.ne.jp/2007-03-10
 が写真付きで詳しい。
 HTML:frames:DOM/earthli が見やすいか?
 **スタイルを変更するときは、-oオプションを付ける [#w8601e25]
 
 phpdocコマンドを使用するとき、
 XXX:YYY:ZZZの前に-oオプションを忘れがちなので、注意!
 >-oを忘れると、何を指定しても、HTMLのデフォルトのスタイルが作られる。
 >PDFやCHMを指定したのに、できていないときは、-oを忘れていないかチェック!
 
 **CHMが生成されないとき [#m32bd000]
 オプション(-o)を忘れているほかに、エラーが発生した場合もCHMは生成されない。
 PDFやHTMLはエラーが発生しても、とりあえず作ってくれるのに対して、CHMは一切、できない。
 ***注意 [#y284df39]
 &color(Red){直でCHMは生成されない};!
 (%%%エラーが出なければ%%%)hhpファイルが生成されるので、HTML Help Workshopで読み込んで、
 コンパイルすればCHMが完成する。
 
 *こんなエラーが出たら、設定が必要 [#x67b86b7]
 >Warning: strftime() [function.strftime]: It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'Asia/Tokyo' for '9.0/no DST' instead in C:\わーくすぺーす\libs\Smarty_Compiler.class.php on line 400
 
 
  
 みたいないエラーが出たら、php.iniにタイムゾーンの設定をしないとだめ。
 http://d.hatena.ne.jp/ema725/20091220/1261321582
  
 date.timezone = Asia/Tokyo
 *文字化け対策について [#x7759edf]
 
 **文字化けしないものもある [#m402f907]
 HTML:Smarty:PHPのみデフォルトで文字化けしない
 
 **文字化けの直し方 [#p53b918e]
 
 ***HTMLの場合 [#v553c923]
 文字コードを決めているheader.tplは、
 C:\php\&color(Red){data};\PhpDocumentor\phpDocumentor\Converters
 の数階層下のtemplatesディレクトリ中にある。
  
 C:\php\&color(Red){PEAR};\PhpDocumentor\phpDocumentor\Converters
 というフォルダもあるが、ここにはない(紛らわしい)
  
 このheader.tplのcharset=iso-8859-1をshift-jisなどに変更する。
 最上段にencodingというのもあって、ここにもiso-8859-1が指定されているので変えておく。
  
 ※ちゃんと該当するtemplateを変えておくこと。
  たとえば、-oオプションにHTML:frames:earthliを指定するのならば、
  上記フォルダ>HTML>frames>templates>earthli>templatesの中にある
  header.tplを変える。
  -oオプションの後の指定は、フォルダの構造と一致しているので対応したheader.tplを修正する。
 **PDFの日本語化 [#s1af33da]
 日本語には非対応なようだ。
 http://www.zend.co.jp/tech/index.php?cmd=read&page=Zend%C0%BD%C9%CA%2F%B5%EC%C0%BD%C9%CA%2FZend%20Studio%204.0%2F%A5%A4%A5%F3%A5%B9%A5%C8%A1%BC%A5%EB%B8%E5%A4%CE%C0%DF%C4%EA
 余談だが、これはZend Studioのページで、Zend Studioは対応していますよ!ということをうたっているのだが、
 Zend Studioは、シェアウェア試用不可:41,790円(税込)
  
 パッチなどあればいいのだが、見つけられなかった。
 ***CHMの場合 [#pfbf334d]
 chm:default:* - output is CHM, compiled help file format (Windows help).
       CHM:default:default - Windows help file, based on HTML:frames:l0l33t
 とあるので、lol33tを日本語化すればいいのかな??
 
 *見つけたPHPドキュメンタまとめ [#oa9fdc2e]
 **phpDocumentor [#le8945df]
 pearコマンドでインストールできる。&color(Red){PDFは日本語は対応していない};。
 CHMは未コンパイルで出てくるので、自分でCHMにしないとだめ(すぐにできる)。
 スタイルの指定が豊富にある。
  サンプル
  http://caspar.hazymoon.jp/php/phpDocumentor/output/frames_earthli/
 
 **PHPDoc [#i0f085bf]
 以前、pearから利用できたようだが、pearから外された。
 Javadocをまんま使ったPHPDocもあるらしい。
  
 **Doxygen [#n0640761]
 PHP以外にもよくつかわれているドキュメンタ。
 &color(Red){PDF・CHMの日本語にも対応};している。
 使い方は、[[こちら>./http://wikiwiki.jp/yonkoushi/?%B4%C9%CD%FD%BF%CD%B8%C4%BF%CD%A5%E1%A5%E2%2Fdoxygen%A4%CE%BB%C8%A4%A4%CA%FD%BF%A7%A1%B9]]を参照。
 使い方は、[[こちら>http://wikiwiki.jp/yonkoushi/?%B4%C9%CD%FD%BF%CD%B8%C4%BF%CD%A5%E1%A5%E2%2Fdoxygen%A4%CE%BB%C8%A4%A4%CA%FD%BF%A7%A1%B9]]を参照。
  サンプル
  http://skazami.web.infoseek.co.jp/tools/doxygen/doxygen_example_html/index.html 
 
 **PHPXRef [#d10602bf]
 perlでできたツール。クラス構造などをドキュメント化するよりも、
 ソースコード自体をドキュメント化することを目的としている。
 具体的には、&color(Red){同じ変数のライトアップや関数へのリンク};など。
 クラス図などは表示されない。
 PDFやCHMへの変換は難しいか?
  サンプル
  http://www.doyouphp.jp/tips/xref_0_6/nav.html?index.html
 
 **どれがいいのか?       [#b3af6b20]
 私見だが、HTMLマニュアルなら、phpDocumentorを使い、PDFマニュアルなら、Doxygenを使うとよいだろう。