国産DIコンテナSeasar その8
■ このスレッドは過去ログ倉庫に格納されています
0838733
2007/01/25(木) 21:44:17JavadocのようなAPIドキュメントなんて、かなり重要な成果物だと思うな。
メソッド名から機能が予想できるような設計が好ましいのは、当たり前の話だし、
ラインコメントが不要でもいいようなコードを書くのも当たり前の話。
それとJavadocが必要・不要は全く別の話。
コードはコード。JavadocはJavadoc。ドメインが違う。
コードを読めばわかるように書いたところで、
バイナリしかなければ仕様はわからない。
そういうときにJavadocが必要になる。
このメソッドを実行したら、nullが返る可能性があるのかとか、
どういう条件で例外が発生するかとか、
バイナリしかなければ、Javadocを読むしかない。
でもJavadocがなければ、実行してみるしかない。
そもそも利用側のコードのテスト計画もできないし、
全てのコードにtry/catchと戻り値のnullチェックが必要になる。
フレームワーク側のコードが信用できないから。
Javadocに仕様が明記されていて、テストコードがあれば、
とりあえずは明記された仕様を満たしていると、
一定の評価はできるので、安心して使うことが出来ると思うのだが。
だからと言って100%仕様を満たしているとは言い切れない。
でも明記されている仕様を満たしていなければ、それはバグである。
仕様が明記されていなければ、仕様なのかバグなのか評価できない。
結果、上記の全ての呼び出し元でtry/catch/nullチェックが必要になるし、
バグの報告も一切出来ない。
■ このスレッドは過去ログ倉庫に格納されています