はじめに
Workatoはレシピ自体の可読性が高いので、チーム開発などで他者が作ったレシピを見た際に、「この処理は一体何をやっているんだろう？想像も付かない…」という状況になることはあまり無いかもしれません。
しかし、「レコード一括取得」などのアクションに見られるような、クエリーを駆使して自由度の高い条件を指定する場合や、formulaモードを利用して複雑なデータ加工をしている場合などには、レシピ作成者以外の人が初見でその動作や意図をくみ取るのは困難です。
コメントを書いておけば、複数の開発者がコメントを通じて意図や背景を共有できますし、将来のリファクタリングや機能追加の際にも、他の開発者や将来の自分がコードを理解しやすくなるため、メンテナンスが容易になります。
コメントの追加方法
皆さんご存じの手順かと思いますが、念の為おさらいです。
該当アクションにマウスカーソルを置くと、右側に「･･･」(三点リーダー)が表示されます。
「･･･」をクリックし、「Add comment」を選択します。
入力モードになるので、コメントを入力します。
「✓」をクリックして、追加完了です。
既存のコメントを修正する場合は、「･･･」をクリックし「Edit comment」を選択して編集します。
トリガーについても、同様の手順でコメントを追加・編集できます。
コメントでの折り返し方法
先ほどのコメントは、読めば内容は分かりますが、長文がつらつらと書かれているので少し見づらい印象を受けます。
こういう時は改行を入れると、見た目が整理されて読みやすくなります。
コメント内で折り返すには、Shift + Enter を入力します。
＜改行を使って整えたコメントの例＞
見出しを付けて構造化したことで、読みやすくなりました。