mmyoji's diary

プログラミングとか日々のどうでもいいこととか

気遣いとしてのREADME

以前に「Railsapp/models/ とか app/controllers/ とかにREADME置いて各ファイルの説明とか書いておくの良さそう」みたいなのをどっかで見て、先日改めて「確かに」と思ったので残しておきます。

Railsに限らず、オレオレフレームワーク的な感じで適当にnamespaceとかdirectory切った時に、そのdir直下に README.md 配置しておいて、

  • そのdirectory にはどういった(責務を負った)ファイルを配置している/すべきなのか
  • 各ファイル(クラス、オブジェクト)の説明。作成した背景など

を書いておくだけでも全然違うかなぁと思ったり思わなかったり。

あとは

こういうメリット(?)もありますよね。

「余計なファイル置いてんじゃねぇ!」「各ファイル内にコメント残しとけばいいだろ!」とかって怒られる可能性も無きにしもあらずですが。

個人的にはあまりコメントとか書きたくない + markdownで書きたいってのがあるので、割と使っていきたい。許されるなら。