【プログラム初心者さんに送る】サンプルプログラムの格納管理方法

ディレクトリ階層Programing
ディレクトリ階層

プログラム初心者さんに送る記事で、前回、サンプルを沢山作りましょうという記事を書きました。

【プログラム初心者さんに送る】サンプルプログラムを沢山作って、大事に貯め込もう
プログラム初心者さんが陥るのは、知識のブレです。「あれって、こうゆうことが出来るんだよね?」と思っていたんだけど全く違うだとか、認識があっているにも関わらず、プログラムでデバッグしていたら「違う知識に変貌してしまう」とか。そういった時に、サンプルをつくったり、サンプルを見返したりすることってとても大事です。そんなサンプルプログラムの管理方法について今日はお話させてください。

こんな風に管理するんですよとお話しましたが、実際のため込む場所の整理方法など、あまり詳しく書いてなかったので、ちょっとだけ追加します。

おさらい

純粋なサンプルを沢山つくるとき、たとえば、こんな感じでファイル命名規則を作っておくといいですとご紹介しました。

例えば、こんな感じです。

sort\sample_0001.php
sort\sample_0002.php
sort\sample_0002A.php
sort\sample_0002B.php

もう少し具体的に書いた方が良かったかなと思いまして、記事にしました。

管理方法

管理方法の指針を具体的にすると、

  • ディレクトリ事に分ける
  • ディレクトリを階層にする
  • ディレクトリの末端にサンプルを置く
  • サンプルが保存してあるとこには README.txtを置く
  • 分類が重複するようなものの対処

という感じです。
具体的に書いていきます。

ディレクトリに分ける

1つの引き出しの中に、こまごましているものを沢山いれると、どこに何があるか分かりにくくなります。
それと同じで、1個のディレクトリ(フォルダ)に、沢山のサンプルがあると、何がどこにあるか分かりにくいことになります。
ですので、ディレクトリ(仕切り)を作って、その仕切りの中にサンプルを置くようにしましょう。

  • ループ文のサンプル
  • 条件が伴うサンプル
  • ソートのサンプル

ディレクトリの名前はなんでもいいんです。
分類を1度決めたら変えられないわけじゃないです。あとでどんどん変えていけばいいんです。
まずは思いつきで分類を決めて、そこにサンプルを入れるようにしましょう。

ディレクトリを階層にする

本屋さんにいくと、コーナーごとに書籍が並んでますよね。

  • ここはビジネス書籍
  • ここは学校関連の本
  • ここは小さい子の本
  • ここはお母さん方が読む本

このコーナーの中をみると、またカテゴリーに分かれてますよね。
たとえば、ビジネス書籍といっても沢山あります。

  • 政治経済
  • 経営
  • 会計
  • 啓発
  • 資格

まだまだ沢山ありますでしょ。
会計と啓発とかって、だいぶ違いますよね。
引き出しのお話を思い出してください。
1個の引き出しにこれらが埋もれてたら、分かりにくいですよね。
ということで、カテゴリもディレクトリに分ける必要があるわけです。
イメージでいうと、こんな感じです。

ディレクトリの末端にサンプルを置く

先ほどの図を観ていただいた時、「実際の書籍」のところへ、サンプルプログラムを格納していきます。
その時、たとえば、冒頭にあげた名前のように、

sample_0001.php
sample_0002.php
sample_0002A.php
sample_0002B.php

のような形で(命名規則にのっとって)、サンプルを置いておくとなるわけです。

こうしておけば、「どこに」「何がありそう」というのが、勘で分かるようになりますよね。

サンプルが保存してあるとこには README.txtを置く

README.txtってなんだ?と思うと思いますが、メモですメモ。
サンプルを作った時に、何か後で分かりやすくするためのメモを、書いておきましょうってことです。
もちろん、プログラムの中でコメントとして書いてもOK。
ただ、ファイルの名前を README.txtと決めておいて、メモがある場合、絶対そこに書くというルールを作ると、運用的に楽ですよという程度です。

実際、git とかでもそうですが、readme.mdなどといった風に、メモ的な話をプログラムとは別にしておくことが多いです。
ちょっと知っておくといいかもですね。

分類が重複するようなものの対処

先ほどの図をみてみてください。

ビジネス書籍⇒政治経済⇒経済⇒「経団連と私」

という風に、分類された書籍がありましたよね。

「経団連と私」という書籍は、「経済」だけに分類される本なのか?

と思うわけです。
社長さんが経団連との関わり合いを書いた本だとすると、「経営」にも該当しませんか?

そうすると、経営の方にも同じ書籍を置いておかないと・・・。となるわけです。

サンプルプログラムも、そっちにもコピーしておこう・・・・

ってなりがちですが、そんなことはしないでください。
同じサンプルが色々なところにあるのは、後で問題が発生します。

万が一、サンプルに書かれている内容が間違えていて修正をしたとしましょうか。
同じサンプルが複数個所にあったりすると、修正箇所が複数個所にまたがりますよね?
絶対、忘れます。

そうすると、「正常なサンプル」「間違ってるサンプル」がバラバラに格納されたままになります。
「間違ってるサンプル」を、参考にしてしまうこともあるかもしれませんよね。

そうならないために、ショートカットを使っておいてください。
たとえば、「経営」のディレクトリに、「経団連と私」へのショートカットを置いておくんです。
そうすることで、「経営」をみた人が、「経済」の中の「経団連と私」へたどり着くことが出来ますね。

(linux等でサンプルを作って管理している場合は、シンボリックリンクを使うと良いでしょう)

まとめ

いかがだったでしょうか。
なんかサンプル1つで細かいことするなーと思う方も沢山おられるかと思います。
ほんとその通りです。
細かいことしてるなです(笑)

無理くりしているってこともあるんですが、こうゆう管理方法を1個でもしていると、システムを作る際に「どう分類すると、どうプログラムが効率化できる」などが思いつくようになります。
例えば、ショートカットはタグみたいなものだよね?とか、そうゆう発想もできますよね。

少し長いお話でしたが、参考にしてみてください。

炭酸野郎

今日も何かを Sagasoonを運用してます。炭酸野郎です。
皆さんの「何か」が探せるべく、記事書いてます。
新卒で中堅SIerに就職→10年ちょいで退職→フリーランス→起業。副業としてのブログに目覚める(今ここ)。
時間作って、色々なことがやりたいお年頃です!

炭酸野郎をフォローする
Programing 初心者 IT
炭酸野郎をフォローする
SAGASOON

コメント

タイトルとURLをコピーしました