1. FileMaker Paradise
  2. 実践編
  3. 計算式にもコメントを

計算式にもコメントを

メンテナンス性を高めよう

メンテナンス性という言葉を聞いたことがあるでしょうか? 保守性ともいわれ、アプリ開発において非常に重要な要素です。

アプリ開発は、一度作ったら「はい、おしまい」というわけには行きません。後々に改良する点が見つかったり、または消費税の増税、改元など様々な社会情勢の変化によって、改良を迫られるケースもあります。

また、会社の業務改善や、上司が変わることによって、業務に対する考え方も変わって、アプリの内容を見直すこともあるでしょう。また、FileMaker(ファイルメーカー)のバージョンアップによっても変更を迫れるケースもあります。

大概の改良は、自分の意図しないタイミングで訪れ、また最初にアプリを作ってから3年後、5年後になってから行う場合もあります。

こういった場合に一番困るのが、このフィールドは何のためにあるのか、このスクリプトは何のためにあるのかといった仕様を思い出せないケースがあります。

FileMakerらしくないことはしたくない

一般的なシステム開発・アプリ開発では、仕様書や要件定義(どんなアプリにしたいかをまとめたもの)を作成して、その文書通りに開発を行っていきます。ただし、FileMakerでは、「安い、うまい、早い」がモットーではないかと思いますので、こういった文書を作成するのは非常に時間がかかる作業なので、ナンセンスという考え方があります。

「あれを作りたい」と思い立ったらすぐにFileMakerを起動して、作って行きたいものです。また、それができるのがFileMakerではあります。この考え方は、FileMaker18になっても、FileMaker19になっても、FileMaker20になっても変わることはないでしょう。

しかしながら、何の考えもなしに、ただ作っていくだけでは、前述したような改良を迫られた場合に、突然作業が止まってしまい、大した改良ではないのに、長い時間がかかってしまうというケースも多々あります。

改良するときに困らないために

いつか来る、改良するときに困らないための第一歩はコメントを活用するということです。スクリプトステップには、コメントというステップがあり、このスクリプトは何のためにあるのか、どういった処理をしているのか、この変数は何のためにあるのかといったことを記しておくことができます。

また、フィールドの設定にはもコメントを記入する欄があり、このフィールドが何のために存在するのか、記録できるようになっています。

意外と知られていない、あるところのにもコメントを残せる

意外と知られていないのが、「計算式」にコメントを残せるということです。

プログラミングの世界では「/*コメント*/」のようにしてコメントを残す場面によく遭遇します。これが、FileMakerの計算式でも使用することができます。

FileMaker(ファイルメーカー)で計算式にコメントを残す

このように計算式のダイアログ内で、コメントを残すことができます。論理関数「ExecuteSQL」論理関数「Case」論理関数「Let」といった関数では、式が複雑になりがちなので、コメントを活用することで、後で、改良が必要になったときに計算式が意味している内容をすぐに把握することができるようになり、メンテナンス性が高まります。

上記の例では、コメントを先頭に掲載していますが、先頭に掲載すると、一覧などで表示されるダイジェストで、コメントしか表示されないケースもあるので、時と場合により、計算式の後に記入するのがいいかもしれません。