ファイルメーカー開発中におけるコメントの重要性!!

今回はスクリプトを記述するときの、コメントの必要性をご紹介します。

 

みなさん、スクリプトにコメントを残していますか?

 

開発中コメントを残す作業は少し面倒だと感じるかもしれません。

しかし、開発中にコメントを残さないと後々、自分や他のメンバーが苦労しもっと面倒なことに発展する場合があります。

 

例えば、下の二つの画像

画像①

画像②

両方とも同じ処理をしています。さて、このスクリプトを見直す場合やアップデートする場合など、どちらが見やすいでしょうか?

 

コメントのないスクリプトは、スクリプトステップを辿りこのスクリプトは一体どんな処理をしているのかをまず、理解する必要があります。

 

それに比べ、コメントのあるスクリプトはステップの合間にどんな処理をするのか等の記述があり理解する労力が少なくて済みます。

 

例題のスクリプトは処理が単純で短いですが、もっと長い複雑な処理をしているスクリプトだった場合を想像してみてください。さらには、自分が書いていないスクリプトだった場合、、、

 

もはや誰も理解できない、暗号文と化します。

 

コメントを残すということは、自分のためであり他の人のためでもあります。

 

スクリプトに限らず、計算式内やフィールドには必ずコメントを残す習慣をつけましょう。