はじめに

いわゆる「良いコード」や「読みやすいコード」を書くためにお手本が欲しくなる時があると思います．本記事では，こういったお手本を探すときに参考になりそうな検索キーワードやリンクを備忘録も兼ねて残そうと思います．Javaを題材にしてまとめてみました．

「良いコード」や「読みやすいコード」を書く基礎になる指針

「変数名が1文字になるのは避けた方が良いよ」や「import文はアスタリスク付きで書かない方が良いよ」といったコードを書く上での指針は基本的にこちらをご参考になさると良いのかなと思います．

「良いコード」や「読みやすいコード」のお手本はこういったコンセンサスの取れたルールみたいなのが基礎になると思いますので，こちらでどんな書き方が良いのか，まずいのかを確認すると良いと思いました．

また，蛇足ですが他にもPythonであればPEP8というコーディング規約が存在するようです．Java以外の規約はないのかといったことが気になった方は「プログラミング言語名　コーディング規約」といった感じで検索すると色々ヒットすると思います．

上記のコーディング規約にも「良いコード」，「読みやすいコード」，「わかりやすいコード」を書くようにしましょうという旨が載っているのですが，これは恐らく規約に従うだけで実現するのは結構難しいと思われます．

なので規約に追加して，「どんな言葉選びがわかりやすいんだろうか」といったことを考えるヒントが必要になるのかなと思います．こういったヒントが載っているのがこちらの記事になるのかなと思います．

個人的には高頻度で拝見させていただいております．

ただし完全に個々のケースに対応した「良いコード，読みやすいコード，わかりやすいコードを書くための方法」はないと思いますので，私がよくやる考え方としては「システムが使われるドメインではどんな単語の使われ方がされているか」などに合わせて命名やアルゴリズムを整理すると良いのかなと思いました．

例えば会計系のシステムであれば，経理などの会計に関するドメイン知識をちょっと勉強して，「どんな言葉選びが伝わりやすいか」，「経理をやっている人たちは頭の中でどんな計算をしているか」などを基に命名や計算のアルゴリズムを考えると良さげなのかなと思われました．

JavaにおいてはJavadocというコメントがあるように，コードにはコメントが存在すると思います．これにも規約があるようなので，コーディング規約のように利用すれば「良いコード」にプラスして「良いコメント」を書く基礎が得られるかと思います．

「Javadoc　規約」，「Java　コメント　規約」とかって検索すると出てきます．

他にも「Java　List　Javadoc」とかって検索するとList型のJavadocのお手本がヒットするのでおすすめです．

おまけなのですが，コメントを日本語で書くときは「です，ます」調で書くと良いそうです．私は「〇〇から△△を取得する」みたいな書き方をしていたので，同じ感じの書き方をなさっていた方がいらっしゃればご参考ください．

「ルールとか規約を使ってある程度のところまでは良いコードや良いコメントが書けそう」という所まで辿り着けるかなと思います．これ以上に質を高めるとなったときにはやっぱりコードを書くのが上手な方たちのコードを覗くのが良いのかなと思いました．

有効そうなアプローチとして，オープンソースを参照するというのがあると思います．「java list java source code」とかって調べるとJavadocだけでなくコードのお手本まで見られます！listの部分を別の変数型などに変えれば別のコードがヒットすると思います

これも個人的な見解なのですが，こういったサイトだとコードの書き方やコメントの書き方が勉強できる上に，アルゴリズムなども勉強できるのでおすすめです．

他の人のロジックに触れる機会は重要かなと思うので，よかったらご覧になってみてください！

この記事ではJavaのお手本コードのリンクと，少しだけ検索テクニックに関してまとめてみました．たまに私の考えも挟まっているのですが，読みづらかったらすみません泣

あと既にコーディング規約などの存在をご存じだった方には役に立たないかと思います泣

ただ個人的には「なんでこの書き方じゃダメなんだ！」っていう方がちょっとでも多くのお手本コードを見つけて「良いコードってこういうのだよね」っていう境地に辿り着けるきっかけになったら良いなと思いまして書いてみました．

かくいう私は勉強中なので自分の勉強も兼ねて共有させていただきました．

お役に立てたら幸いです