初めに
今回は意外と気にしてる人が少ない可読性のために自分が普段気を付けていることを紹介していきます
本文
KDocコメント
まずはKDocコメントですKDocコメントとは下記のような形式で書かれたコメントです
中にクラス名やパラメータ名を[]で囲むことで検索をかけたりすることができます。
また、複雑な処理をしている関数などに軽い説明を入れることでパッと見ただけで他者がどんな関数なのかがわかりやすくなります
/**
*
*/
ファイリング
正式になんといえばいいのかがわからないので今回はファイリングという名前で紹介させていただきますが、やってることはとても単純で適切なパッケージや適切なクラスなどにわけることです。
例えば、データクラスを加工する処理を何か所にも同様のものを書いたり、データクラスに複雑な加工処理を何個も書くのはデータの置き場であるはずのデータクラスのコード量をファットにして非常に可読性が悪くなってしまいます
最後に
今回は自分が可読性を上げるために特に気を付けていることを紹介していきました
どなたかのお役に立てれば幸いです