Power Appsでアプリを開発する際、コードの可読性や管理のしやすさを向上させるためには、適切な名前付け規則を採用することが重要です。本記事では、変数、データソース、スクリーン名、コントロール名などの名前付けのベストプラクティスを解説します。
キャメルケースとパスカルケース
名前付けには「キャメルケース」と「パスカルケース」の2つのスタイルが使用されます。
- キャメルケース(camelCase): 小文字で始め、各単語の最初の文字を大文字にする。
- 例:
txtUserEmailAddress
- 例:
- パスカルケース(PascalCase): すべての単語の最初の文字を大文字にする。
- 例:
Office365Users
- 例:
使用ルール
名前の種類 | 形式 | 例 |
---|---|---|
コントロール | キャメルケース | txtUserName |
変数 | キャメルケース | locUserEmail |
データソース | パスカルケース | SharePointList |
スクリーン名 | パスカルケース | HomeScreen |
スクリーン名の命名規則
アプリのスクリーン名は、画面の目的を明確に示すべきです。スクリーンリーダーでの読み上げにも配慮し、スペースを含めず、略語は避けましょう。
推奨例:
HomeScreen
SearchScreen
避けるべき例:
Home
LoaderScreen
EmpProfDetails
コントロール名の命名規則
各コントロールには、識別しやすい名前を付けることが推奨されます。3文字の略称を先頭に付けることで、コントロールの種類を明確にできます。
コントロール名の例
コントロール | 略称 | 例 |
---|---|---|
ラベル | lbl | lblUserName |
ボタン | btn | btnSubmit |
テキスト入力 | txt | txtEmail |
ドロップダウン | drp | drpCountry |
ギャラリー | gal | galProducts |
フォーム | frm | frmRegistration |
データソース名の命名規則
Power Appsでは、データソース名は基本的に変更できませんが、適切な名前を付けることが推奨されます。
例:
Office365Users
(Office 365 ユーザー コネクター)Employees
(SharePoint リスト)Contractors
(SharePoint リスト)
変数名の命名規則
変数にはキャメルケースを使用し、用途を明確にするための接頭辞を付けます。
変数の接頭辞例
変数の種類 | 接頭辞 | 例 |
---|---|---|
グローバル変数 | gbl | gblCurrentUser |
コンテキスト変数 | loc | locFormData |
数値変数 | num | numTotalPrice |
文字列変数 | str | strUserName |
ブール変数 | bool | boolIsActive |
避けるべき例:
dSub
rstFlds
hideNxtBtn
EID
(短縮しすぎ)
コレクション名の命名規則
コレクションの命名には col
の接頭辞を使用し、意味のある名前を付けます。
例:
colMenuItems
colThriveApps
避けるべき例:
orderscoll
tempCollection
コメントとドキュメント
コードの可読性を向上させるため、適切なコメントを追加することが重要です。
コメントの種類
- 行コメント:
//
を使用// ユーザーリストを取得 ClearCollect(colUsers, Office365Users.SearchUser({searchTerm: ""}))
- ブロックコメント:
/* */
を使用/* この関数は、ユーザー情報を取得して ラベルに表示する処理を行う。 */
インデントと書式設定
Power Appsの数式バーでは、読みやすさを向上させるために適切なインデントを活用しましょう。
インデントの例
ClearCollect(
colExpenses,
{
Title: "出張費用",
Amount: 5000,
Category: "交通費"
}
)
目次
まとめ
Power Appsの名前付け規則を適用することで、コードの可読性が向上し、開発や保守が容易になります。以下のポイントを守ることで、より効率的なアプリ開発が可能です。
- キャメルケースとパスカルケースを適切に使い分ける
- スクリーン名は明確にし、略語を避ける
- コントロール名には3文字の略称を付ける
- データソース名は明確で一貫性のあるものにする
- 変数とコレクション名には接頭辞を付ける
- 適切なコメントを記述し、インデントを活用する
これらのルールを活用して、Power Appsのアプリ開発をスムーズに進めましょう!
コメント