Effective java 3版 読書会 13日目

実施日時:2019/4/4 22:00~23:00
対象範囲:項目55~項目56
参加者:yodai、yoridori、kassyi
形式:オンライン(discord)
   課題本を事前に読み、実業務と照らし合わせて記述内容の
   議論をする。

項目55 オプショナルを注意して返す
オプショナルを返す方法はやり易く、nullを返すよりオプショナルの方が良い。
オプショナル返すメソッドでnullを返した事が有るので、単体テストなどで注意してチェックするべき
ボクシングされた基本データ型のオプショナルは決して返すべきでない。
マップのキーにオプショナルを使用するべきでない。
いちいちNullチェックする必要が無いので、使ってみると便利

項目56 すべての公開API要素に対してドキュメントコメントを書く
公開されているインターフェースは、ドキュメントを書くべき
publicとprotectedは書く必要がある。
また、コンストラクタ、throwsやexceptionも必要
エラー用のクラスを作成、元のクラスのエラー用の変数に格納し、
呼出元に戻してエラー内容を記述する。
エラーメッセージを書く時に、元のクラスを引き継ぐ。
プロジェクトとしてどのタイミングでエラー出すかを決めるべき
SQLエクセプションなどはパラメータを格納する必要があり、そうでなければ解析が難しくなる。
何を行っているかやパラメータを記述する。
加えて副作用を記述する。
PタグはクラスのJavaDocは使うけど、メソッドは使わなかった。
具体的な処理内容は書かない。
JDKのJavaDocを見て参考にする
ジェネリック型やジェネリックメソッドは、全てのパラメータを文書化するべき
@inheritDocという、スーパークラスからドキュメントコメントの一部を継承するタグが有る。

協力:Tech Baton
https://tech-baton.studio.design/

この記事が気に入ったらサポートをしてみませんか?