【ソフトウェア設計】ドキュメントとしてのコメント

はじめに こちら最近書いてるソフトウェア設計シリーズです。モジュールをどう分割するのか？や【ソフトウェア設計】モジュールになぜ分けるのか？などの記事を書いています。今回はコメントの話を中心に書いていこうと思います。 TL;DR コード「も」仕様書、コメント「も」仕様書 Howでは無く、What。WhatよりWhy Whatが多い場合はモジュール化も検討 コードは仕様書なのか？ 「コードが仕様書か否か」はプログラマーにとってお気に入りの争いの一つです。ある人は「仕様書は要らない。コードを読め」と言い、ある人は「仕様書は大事」という話をします。それぞれの主張はあるでしょうが、この記事では 「コードも仕様書」 という立場を取ります。 この議論は、前提として 「仕様書とは？」 を定義する必要があります。ソフトウェア開発の現場では様々な仕様書が存在します。ともすればやや古典的ですらある分類として如何