Power Automateの変数命名規則。後で見てもわかる変数名のつけ方とルール設計

Power Automateの変数名は、後から読む人(自分含む)のためにつける

Power Automateのフローを作っていると、変数名を何となくvar1・temp・flagのようにつけてしまいがちです。動いているうちは問題ありませんが、1ヶ月後に修正しようとしたときこれ何の変数だったっけとなります。変数名の付け方をルール化しておくだけで、後のメンテナンスコストが大きく変わります。

おすすめの命名規則:プレフィックス+意味のある名前

変数の種類ごとにプレフィックスをつける方法が読みやすく、一般的にも広く使われています。

種類プレフィックス
文字列(String)strstrApplicantName、strMailBody
整数(Integer)intintRecordCount、intRetryLimit
真偽値(Boolean)bln または isblnIsApproved、isCompleted
配列(Array)arrarrTaskList、arrRecipients
オブジェクト(Object)objobjCurrentUser、objConfig
日時(DateTime)dtdtTodayJST、dtDueDate

プレフィックスをつけることで、変数名を見ただけで型がわかります。Power Automateでは型エラーが出ることがあるので、型を意識した名前をつけておくと原因特定も早くなります。

名前の付け方の3原則

① 何が入っているかを名前にする

変数の用途ではなく、入っている値の内容を名前にします。

  • NG:strTemp、strWork、str1
  • OK:strApplicantName、strSubjectLine、strErrorMessage

「何のための変数か」より「何が入っているか」を名前にする方が、後から読んだときにすぐわかります。

② 略語は最小限にする

略語を多用すると名前が暗号になります。一般的に通じる略語(ID、URL、JST、UTCなど)以外は省略しないほうが読みやすいです。

  • NG:strApNm、intCnt、dtDl
  • OK:strApplicantName、intCount、dtDeadline

③ 複合語はキャメルケースで書く

複数の単語を組み合わせる場合は、単語の区切りを大文字にするキャメルケースが読みやすいです。

  • NG:strrecordcount、str_record_count
  • OK:strRecordCount

スペースやアンダースコアは式で参照するときにエラーの原因になることがあるので、キャメルケースが無難です。

フロー全体での変数管理のコツ

変数の初期化はフロー冒頭にまとめる

Power Automateの変数はフローの途中で初期化できません(使う前に必ず初期化が必要)。フロー冒頭に変数の初期化アクションをまとめておくと、どんな変数を使っているか一目で把握できます。

初期化アクションをまとめる場所が決まっていると、変数の棚卸しもしやすくなります。使われなくなった変数が残っていないかを定期的に確認する習慣もつけておくとよいです。

ループ内の一時変数には local をつける

Apply to each の中だけで使う一時的な変数は、接頭辞にlocalをつけると「このスコープだけで使う変数だ」とわかりやすくなります。

  • localStr…、localInt… のように命名する
  • ループを出た後は参照しないことを明示できる

作成(Compose)で定数を管理する

フロー内で固定値として使う文字列(メール送信先、設定値、定型文など)は作成(Compose)アクションに入れておくと管理しやすくなります。変数と違い上書きされる心配がなく、「定数」として扱えます。

// 作成「設定:送信先メールアドレス」
admin@example.com

作成(Compose)に意味のある名前をつけておけば、後から変更が必要なときも一か所を変えるだけで済みます。作成(Compose)アクションの活用方法は別記事でまとめています。

Power Automateの作成(Compose)アクション——デバッグと式の整理に使う実践ガイド

チームで運用するフローでの追加ルール

自分だけが使うフローと、チームで共有するフローでは求められる丁寧さが変わります。複数人が触るフローでは、以下も意識しておくとよいです。

  • アクション名にも説明をつける(デフォルト名のままにしない)
  • スコープアクションでアクションをグループ化して意図を明示する
  • コメントアクションで処理の意図を残す

変数名だけでなく、アクション名も「HTTP」「作成」のままにせず「HTTP:〇〇APIを呼び出す」「作成:本文テキストを組み立てる」のように意図を書いておくと、引き継ぎのときに格段に楽になります。

まとめ

Power Automateの変数命名は、プレフィックス+内容の英語キャメルケースで統一するのがおすすめです。何が入っているかを名前にする、略語は最小限にする、複合語はキャメルケースにする、の3原則を守るだけで後から読んでもわかるフローになります。

変数名の付け方は地味ですが、フローが増えてくると効いてきます。最初から習慣にしておくほうが後から直すより楽なので、今日から取り組んでみてください。

Xでフォローしよう