質問: javascriptのソースコードをフルスクラッチで新規に書いていくことになった場合の、設計法と保守性が高く再利用性と再編集のしやすさと見通しの良いコードを書くにはどのような方法を使うのがベストかをお聞きしたいです。 現状としては、500~1000行以上あるjavascriptのコードを一つのファイルで管理することを想定しております。 また、参考に書籍やサイトなどがあれば教えていただけないでしょうか? よろしくお願いいたします。
回答: まずこの話題についてはベストな方法はなくケースバイケースだと思います。 「設計法と保守性が高く再利用性と再編集のしやすさと見通しの良いコード」という条件を一つ一つ分類して考えてみましょう。 まず「設計法」については、意図が掴みにくいですが、「どのような前提(設計)をもとにこのコードが作られたか」ということを示す条件だと想定します。 例えば「JavaScriptで電卓を作る」ということですと、まず何故JavaScriptで作ろうと思ったのか、クライアントアプリではダメなのかといったコードの存在経緯の部分や、○○の技術、○○フレームワークを用いた設計を試すために作ったテストプロジェクトである、等というコードの存在目的や設計思想の部分が該当するかと思います。 これはファイル冒頭やプロジェクト内のReadMeなどのコメント用ファイル等に入念なコメントを入れることが第一の解決策になります。 後から見たときに、「このコードはなんのために存在しているのか」が把握できるということを念頭に詳細なコメントを記載すれば解決に向かうと思われます。 GitHub等のプロジェクト外ツールで色々な管理を行う方法もあると思いますが、最終的にはすべて過去のコメントが拠り所となります。 次に「保守性が高く」という部分については、個人で利用するのであればそこまで深く考えなくても良いと考えます。保守性の低さが大きな問題になるのは、多くはコードの引き継ぎが行われた場合に、元々のコードの品質に関わらずつぎはぎだらけの修正が繰り返され、最終的にコードの品質が著しく低下し、問題を抱えたままシステムを運用することになるようなケースだと思います。 個人利用であれば修正点が把握できないほどのコード修正をかけることもそうは無いと思いますし、自分が作ったコードであれば適宜リファクタリング(コードの動きを変えずに、コードの内容を見易いように修正すること)をする機会もあるでしょう。 そもそも品質の高いコードを書く手法ということであれば、「関数やオブジェクトの管理方法」程度で改善できるものでもないと考えますので割愛します。 「再利用性と再編集のしやすさと見通しの良い」という部分はまとめて書いてみたいと思いますが、あくまで個人利用であれば、すべての要点は「未来の自分が過去の自分のコードを見たときに、過去の自分が考えたことが把握できるかどうか、またそのスピードが速いかどうか」という話題に絞れると思います。 様々なポイントがあると思いますが、最も重要な点はコードの検索性だと思います。つまり探している該当の機能がどこに書かれているかが瞬時に把握できるということです。 これを解決するためにはコードを自分なりに分類して、その結果をどこか(設計法にも出てきたファイル冒頭やプロジェクト内のReadMeなどのコメント用ファイル等)に明示しておくことです。そこを見ればどのように関数や変数が分類され、どこに書かれているかを未来の自分に伝えるようにしておきます。 ただしここが一番のポイントかつ難しいところです。分類の仕方は無数に存在するからです。 yambejpさんのアドバイスにもありますが、「○○によって変わってくる」という要素が非常に強いです。何かフレームワークを利用するかによっても違いますし、何を扱うコードなのかによっても変わります。 分類の仕方も1種類ではありません。ですので回答者側から画一的な分類方法を伝えることも難しいです。 この点についてはまず1~2割程度ノールールでコードを書いてみて、少しずつコードの分類をしていくのが良いかと思います。個人利用であれば最初にルールを決めてから進める必要も無いと思いますので。 ある程度コードの骨格が出来上がってきたら、どこかのタイミングで「コードの分類を検討する」というフェーズを入れることにし、そこで自分が書いてきたコードの分類を行い、それ以後はそのルールに則ってコーディングをしていくようにすれば良いと思います。