スタッフBLOG

おはようございます。本日の当番、プログラマのY.Hです。

先日、知人とお寿司屋さんに行きました。
いつも行っているところではなく、
たまには違う店にしようということで別の店に行くことに。

いざ注文しようとメニューを見ると…
なんと、僕のお気に入りのだし巻き卵が
メニューにないではないですか

少しの間、絶望しましたが、
お店の人に聞いてみるとメニューに書かれていないだけで
ありますよ～とのこと。
とりあえず一安心でしたｗ


さて、プログラムにおいて
飲食店のメニューにあたるのはドキュメントだと思うのですが、
プログラム処理は実装されているけど、
ドキュメントに書かれていないといったケースが良くあります。

他人が作ったプログラムを触る際、
一緒にドキュメントを渡されることもあるのですが、
ソースコードの内容と一致してないこともしばしば。

書かれていないクラスや関数があったり、
その逆もまた然り…。

ドキュメントを更新すれば良いのですが、
忙しくてなかなか難しい人も多いのではないでしょうか。

まぁ、ソースコードからドキュメントを自動生成する方法もあるので、
そちらを使うというのもありですが。


…というわけで、ドキュメントを見て分からないことがあれば
ソースコードを見るようにしています。

ソースコードを見ていけばドキュメントに頼らずとも
実装されている内容がわかりますよね。
まぁ読み解くのに時間はかかるかもしれませんが（汗

ただし、ソースコードが公開されていないライブラリについては
どうしてもドキュメント頼りになってしまいますので、
そのあたりは注意が必要ですね。


今度またそのお店に行ったら、
他の裏メニューを探してみようかなｗ