質問: こんにちは。当方プログラミング初心者です。 最近、こちらで色々質問させてもらいながらオセロプログラムを完成させました。 しかしながら、設計図を全く作らなかったこともあり、変数やメソッドなど当初の予定にはなかったものを様々に書き加える必要があったせいで非常に読みづらくわかりにくいコードになってしまいました。 そこで、次は設計図を作って読みやすいプログラムを書き直そうと考えているのですが設計図といってもどう書き始めていいかわかりません。 皆さんはプログラムを書き始める前にどのようなことを考えていますか? さらに読みやすいコードを書くためにどのような工夫をしているでしょうか。
回答: プロであれば標準規格の設計方式などを身に着ける必要がありますが、 そうでなければ、設計図はまず、フリーフォーマットで書いてみてはいかがでしょうか。 無地の紙(ちらしの裏とかでOK)にそのプログラムに必要なことを書き出していきます。 最初はラフでかまいませんので、いったん書き出せたら、それを清書します。 ラフも清書も何かのエディターを使って書いても良いです。最初は自分のやりやすい方法で。エディターの方が手直しが楽なので慣れてきたらそちらのほうが良いと思います。 あとはそれを一定の法則にしたがってコードに起こしていきます。 「下書き」のようなものと思っていただければ良いです。 書き方が分からなければ、ユースケース図のようなものを参考にしてみると良いでしょう。 2.ユースケース図 2 | TECHSCORE(テックスコア) 読みやすいコードを書くというのは、 設計とはまた違うテクニックだと思います。 ここには書ききれないのでポイントだけ。 それは「統一されている」ことです。 あるルールに従って書かれていて、それが徹底されていること。 特に、そのプログラミング言語で標準的である書き方をすることです。 Javaであれば、IDEの自動フォーマッターやコーディングルール支援プラグインなどを使うのも良いです。 参考リンク: GoogleのJavaコーディング規約 各プログラミング言語のコーディング規約まとめ - Qiita