ドキュメント

dev 
あと、ドキュメント重要。でもソースに書いてある。
Wiki にも書くけど細かいことは RDoc 読め。が、今どきじゃないのかな。

http://f50.aaa.livedoor.jp/~wtnabe/diary/index.cgi?date=20050223#p02

僕は、ライブラリは、ユーザに、たとえコメントを読ませるだけとはいえ、コードを見せないことが重要だと考えてる。

  • OOPの隠蔽の特徴を生かすため。コメントだけでなくコードまで見てしまうことを排除する。
  • コード内のコメント＝仕様とすると、細かいところで矛盾や不具合が起きる可能性が高い
  • ユーザにとっては、コード読むより、ドキュメント読むほうが間違いなく理解できる

Rubyではそうでも無いのかも知れないが、PHP4では変数にパブリック、プライベートの差がない（PHP5でも無しとできる）ので、特に重要となってくる。