javaのモデルクラスのアクセサがわかりにくい

Question

はじめまして
java springで開発をしています。

モデルクラス（DTO）のアクセサについて質問です。

今の開発現場ではDTOのフィールドはprivateで宣言し、アクセサは@Setter,@Getterとアノテーションで実装しています。

ここで質問です。

実装時に気づいたのですが、アクセサにフォーカスにしてもコメントが無く、設計書は日本語で非常に分かりにくいです。

フィールドの「命名がそもそも良くない」という大問題はあるのですが、文化的に命名を見直すというのは現実的では無いです。

アクセサにフォーカスした時にコメントが表示されると、救いがあるのですが、上述したとおりアクセサはアノテーションで実装しているので、コメントもつけられず困っています。

きっと命名をちゃんとわかりやすくしましょう、という初歩的なことではあるのですが、もしそれ以外に何かアイデアや工夫がありましたらご教示ください。

Answer 1

アクセサにフォーカスにしてもコメントが無く、設計書は日本語で非常に分かりにくい

Lombokで自動生成されるメソッドなので、Javadocは生成されませんし、設計書は日本語で非常にわかりにくいのとは別問題だと私は思います。その理由として、アクセサ(getメソッド)は単にフィールドの内容を返すものですから、そのフィールドを参照すれば解決する話であって、そのフィールドと設計書の内容が非常にわかりにくいのは、設計や命名にこそ問題があります。

また、常に @Getter @Setter を使うのではなく、仕方なくWebからのリクエスト情報をバインドする箇所や、データソースから値を取得する際の格納時にフレームワークの都合で用意することはありますが、それ以外はイミュータブルな状態でインスタンスを扱うよう@Valueを適宜使うことを検討します。

Answer 2

「@Setter,@Getter」というのは、lombokの機能を指しているのだと認識していますが、間違いないですよね？
「コメント」というのは、EclipseやVSCodeなどのIDEにて、フィールドにフォーカスした際に表示されるjavadocのことを指しているのだと認識していますが、間違いないですよね？

上記の内容に間違いがないのであれば、以下の回答を確認してください。
lombokには@Setterや@Getterにjavadocを付与する機能はありません。
Delombokを使用して、ソースコードを変換したのち、javadocを作成する必要があります。

参考：https://stackoverrun.com/ja/q/8889808

解決策としては、
「命名を良くする」というのが一番簡単だと思います。文化を見直す良い機会なのではないですか？
ほかには、privateではなくpublicにするなど。（@Setterや@Getterを使うならカプセル化する意味はあまりないのでは？）

Comments

[kometaroimo0214]

返信ありがとうございます。また行間をよみとっていただきありがとうございます。
問題解決の軸が違う！というのはごもっともなのですが、現場のいわゆる大手様の文化や商習慣など前提条件がある中で「なんとかならないか」というご相談でした。返信いただきましたURLも参考にさせていただきましたが、なるほどjavadocを付与するというよりも、そもそもカプセル化が不要という議論をすれば、現状課題を解決出来そうに思いました。ありがとうございました。