Bagikan melalui

Keterbacaan kode

Konvensi penamaan

Konvensi penamaan umum

Bagian ini menjelaskan konvensi penamaan "camel case " dan "Pascal case". Jika Anda sudah terbiasa dengan istilah-istilah tersebut, Anda dapat melewatinya.

Camel case

Anda harus menggunakan camel case untuk kontrol dan variabel. Camel case dimulai dengan awalan huruf kecil, menghapus semua spasi dari nama objek atau variabel, dan menggunakan huruf besar pada huruf pertama dari setiap kata setelah yang pertama. Misalnya, kontrol input teks mungkin bernama txtUserEmailAddress.

Pascal case

Anda harus menggunakan Pascal case untuk sumber data. Pascal case kadang-kadang disebut sebagai "upper camel case." Seperti camel case, ini menghapus semua spasi dan menggunakan huruf besar pada huruf pertama kata. Namun, tidak seperti camel case, Pascal case juga menggunakan huruf besar pada kata pertama. Misalnya, sumber data umum di Power Apps adalah konektor Pengguna Microsoft Office 365, yang diberi nama Office365Users dalam kode Anda.

Nama layar

Nama layar harus mencerminkan tujuan layar, sehingga lebih mudah untuk menavigasi aplikasi yang kompleks di Power Apps Studio.

Yang kurang jelas adalah bahwa nama layar dibacakan dengan lantang oleh pembaca layar, yang diperlukan untuk pengguna yang memiliki kebutuhan aksesibilitas penglihatan. Oleh karena itu, sangat penting bagi Anda untuk menggunakan bahasa sederhana untuk memberi nama layar Anda dan nama tersebut menyertakan spasi dan tidak ada singkatan. Selain itu, kami menyarankan Anda mengakhiri nama dengan kata "Screen", sehingga konteksnya dipahami saat nama diumumkan.

Berikut adalah beberapa contoh yang bagus:

  • Home_Screen atau Home Screen
  • Search_Screen atau Search Screen

Tangkapan layar yang menampilkan daftar nama layar yang mengikuti pola yang dijelaskan

Contoh nama layar ini kurang dapat dipahami:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Nama kontrol

Semua nama kontrol pada kanvas harus menggunakan camel case. Mereka harus dimulai dengan deskriptor tipe tiga karakter, diikuti dengan tujuan kontrol. Pendekatan ini membantu mengidentifikasi jenis kontrol dan memudahkan pembuatan rumus dan pencarian. Misalnya, lblUserName menunjukkan bahwa kontrol adalah label.

Tabel berikut menunjukkan singkatan untuk kontrol umum.

Nama kontrol Singkatan
Lencana bdg
Button btn
Kontrol Kamera cam
Kanvas dapat
Card crd
Bagan chr
CheckBox chk
Koleksi col
Combo box cmb
Komponen cmp
Wadah con
Tanggal dte
Drop down drp
Formulir frm
Galeri gal
Grup grp
Kop hdr
Teks Html htm
Icon ico
Image img
Tombol info info
Label lbl
Tautkan lnk
List box lst
Mikrofon mikrofon
Microsoft Stream str
Bentuk bagian halaman dtk
input pena pen
Ubin Power BI pbi
Panel Progres pbar
Penilaian rtg
Rich text editor rte
Bentuk (persegi panjang, lingkaran, dan sebagainya) shp
Penggeser sld
Daftar tab tbl
Table tbl
Text input txt
Pengatur Waktu tmr
Toggle tgl
Video vid

Daftar kontrol terperinci dan propertinya dijelaskan dalam Referensi kontrol.

Catatan

Nama kontrol harus unik di seluruh aplikasi. Jika kontrol digunakan kembali di beberapa layar, nama layar pendek harus memiliki akhiran. Misalnya, galBottomNavMenuHS di mana "HS" berarti "Layar Beranda". Pendekatan ini memudahkan untuk mereferensikan kontrol dalam rumus di seluruh layar.

Berikut adalah beberapa contoh yang buruk:

  • zipcode
  • Next

Saat Anda secara konsisten memberi nama untuk kontrol, aplikasi Anda lebih bersih dalam tampilan navigasi, dan kode Anda juga lebih bersih.

Tangkapan layar tampilan navigasi yang menunjukkan nama kontrol mengikuti pola

Nama Sumber Data

Saat Anda menambahkan sumber data ke aplikasi, nama tidak dapat diubah di aplikasi Power Apps. Nama diwarisi dari konektor sumber atau entitas data yang berasal dari koneksi.

Berikut adalah beberapa contoh:

  • Nama yang diwarisi dari konektor sumber: Konektor Pengguna Office 365 adalah namedOffice365Users dalam kode Anda.
  • Entitas data yang berasal dari koneksi: Daftar Microsoft SharePoint bernama Employees dihasilkan dari konektor SharePoint. Oleh karena itu, nama sumber data dalam kode Anda adalah Karyawan. Aplikasi Power Apps yang sama juga dapat menggunakan konektor SharePoint yang sama untuk mengakses daftar SharePoint bernama Contractors. Dalam hal ini, nama sumber data dalam kode adalah Contractors.

Untuk informasi selengkapnya tentang konektor dan koneksi, lihat Gambaran umum konektor aplikasi kanvas untuk Power Apps.

Konektor tindakan standar

Dalam konektor tindakan standar yang mengekspos fungsi, seperti LinkedIn, nama sumber data dan operasinya menggunakan casing Pascal. Misalnya, sumber data LinkedIn bernama LinkedIn dan memiliki operasi bernama ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Konektor kustom

Konektor kustom yang digunakan untuk terhubung ke antarmuka pemrograman aplikasi (API) kustom seperti layanan atau API lini bisnis yang telah dibuat perusahaan Anda. Mereka dapat dibuat oleh pembuat mana pun di lingkungan Anda. Kami merekomendasikan casing Pascal untuk nama sumber data dan operasinya. Ketahuilah bahwa nama konektor kustom dan cara kemunculannya di Power Apps dapat berbeda.

Pertimbangkan contoh konektor kustom bernama MS Auction Item Bid API ini.

Tangkapan layar konektor bernama MS Auction Item Bid API

Namun, saat Anda membuat koneksi dari konektor ini dan menambahkannya ke aplikasi Power Apps Anda sebagai sumber data, koneksi tersebut muncul sebagai AuctionItemBidAPI.

Screenshot konektor yang menunjukkan bahwa namanya adalah AuctionItemBidAPI

Untuk mengetahui alasannya, Anda dapat melihat di dalam file OpenAPI untuk atribut judul yang berisi teks Auction Item Bid API.

"info": {
    "version": "v1",
    "title": "Auction Item Bid API"
},

Power Apps menghapus semua spasi dari nilai atribut ini dan menggunakannya sebagai nama sumber data Anda.

Tip

Sebaiknya ubah nilai atribut ini menjadi nama berhuruf Pascal case seperti AuctionItemBidAPI dan menggunakannya sebagai nama koneksi kustom Anda. Dengan cara itu, tidak akan ada kebingungan. Ubah nilai ini sebelum Anda mengimpor file OpenAPI untuk membuat konektor kustom.

Catatan

Jika Anda menggunakan opsi Buat dari kosong alih-alih mengimpor file OpenAPI yang ada, PowerApps akan meminta nama konektor kustom kepada Anda. Nama ini akan digunakan baik sebagai nama konektor kustom dan sebagai nilai atribut judul di dalam file OpenAPI. Pastikan untuk menggunakan nama ber-Pascal case seperti AuctionItemBidAPI untuk menjaga hal-hal tetap konsisten dan sederhana.

DataTables Excel

PowerApps menggunakan DataTables untuk Microsoft Excel menyambungkan ke data di lembar kerja Excel. Ingatlah poin-poin ini saat Anda membuat dokumen Excel sebagai sumber data:

  • Berikan nama deskriptif DataTables Anda. Nama itu ada di aplikasi Power Apps saat Anda menulis kode untuk menghubungkannya.
  • Gunakan satu DataTable per lembar kerja.
  • Berikan nama yang sama untuk DataTable dan lembar kerja.
  • Gunakan nama kolom deskriptif di DataTables.
  • Gunakan casing Pascal. Setiap kata dari nama DataTable harus dimulai dengan huruf kapital, seperti EmployeeLeaveRequests.

Nama variabel

Konvensi penamaan untuk variabel di aplikasi kanvas penting untuk menjaga keterbacaan, konsistensi, dan kejelasan dalam proyek Power Apps Anda. Meskipun tidak ada standar ketat yang diterapkan, mengadopsi konvensi penamaan yang konsisten di seluruh aplikasi kanvas Anda dapat memudahkan Anda dan kolaborator lain untuk memahami, menggunakan, dan mengelola variabel.

  • Gunakan camel case, di mana huruf pertama dari setiap kata dikapitalisasi kecuali kata pertama.
  • Pilih nama yang bermakna dan deskriptif yang dengan jelas menggambarkan tujuan atau isi variabel. Hindari nama yang terlalu umum seperti temp atau var1. Sebagai gantinya, gunakan nama deskriptif seperti userEmail atau totalAmount.
  • Pertimbangkan untuk menggunakan awalan atau akhiran untuk menunjukkan jenis variabel. Misalnya:
    • strUserName untuk variabel teks/string
    • numTotalAmount untuk variabel numerik
    • boolIsEnabled untuk variabel Boolean
    • locVarName untuk variabel lokal/variabel konteks
    • gblVarLoginUser untuk variabel global
  • Putuskan apakah variabel Anda harus diberi nama dalam bentuk tunggal atau jamak dan tetap berpegang pada konvensi itu. Misalnya, gunakan userCount atau users secara konsisten.
  • Hindari menggunakan kata yang sudah digunakan orang atau nama yang mungkin bertentangan dengan fungsi Power Apps atau kata kunci. Periksa dokumentasi Power Apps untuk daftar kata yang sudah digunakan.
  • Pertimbangkan untuk menggunakan awalan yang memberikan konteks tentang penggunaan atau cakupan variabel. Contoh:
    • frm untuk variabel formulir
    • col untuk koleksi
    • var untuk variabel tujuan umum
  • Hindari karakter khusus. Pertahankan nama alfanumerik dan hindari karakter atau spasi khusus. Berpegang teguh pada huruf dan angka.

Power Apps mengizinkan variabel konteks dan variabel global memiliki nama yang sama. Hal ini dapat menyebabkan kebingungan karena rumus Anda menggunakan variabel konteks secara default kecuali operator disambiguasi digunakan.

Hindari situasi ini dengan mengikuti konvensi ini:

  • Variabel konteks awalan dengan loc.
  • Variabel global awalan dengan gbl.
  • Nama setelah awalan harus menunjukkan maksud/tujuan variabel. Beberapa kata dapat digunakan dan tidak harus dipisahkan oleh karakter khusus apa pun, seperti spasi atau garis bawah, jika huruf pertama dari setiap kata dikapitalisasi.
  • Gunakan Camel casing. Mulailah nama variabel Anda dengan awalan dalam huruf kecil, lalu gunakan huruf besar pada huruf pertama dari setiap kata dalam nama.

Contoh-contoh ini mengikuti standar dan konvensi:

  • Variabel Global:gblFocusedBorderColor

  • Variabel konteks:locSuccessMessage

  • Variabel cakupan:scpRadius

Contoh-contoh ini tidak mengikuti standar dan lebih sulit dipahami:

  • dSub
  • rstFlds
  • hideNxtBtn
  • ttlOppCt
  • cFV
  • cQId

Hindari nama variabel pendek dan samar seperti EID. Use EmployeeId justru.

Jika ada banyak variabel dalam aplikasi, Anda cukup mengetikkan awalan di bilah rumus untuk melihat daftar variabel yang tersedia. Jika mengikuti panduan ini untuk memberi nama variabel, Anda dapat menemukannya dengan mudah di bilah rumus saat mengembangkan aplikasi. Pada akhirnya, pendekatan ini mengarah pada pengembangan aplikasi yang lebih cepat.

Nama kumpulan

  • Deskripsikan isi koleksi. Pikirkan tentang apa yang terkandung dalam koleksi dan/atau bagaimana penggunaannya, lalu beri nama yang sesuai.
  • Koleksi harus diawali dengan col.
  • Nama setelah awalan harus menunjukkan maksud/tujuan variabel koleksi. Beberapa kata dapat digunakan dan tidak harus dipisahkan dengan spasi atau garis bawah, jika huruf pertama dari setiap kata dikapitalisasi.
  • Gunakan Camel casing. Mulailah nama koleksi Anda dengan awalan col huruf kecil, lalu gunakan huruf besar pada huruf pertama dari setiap kata dalam nama.

Contoh ini mengikuti konvensi nama koleksi:

  • colMenuItems
  • colThriveApps

Contoh ini tidak mengikuti konvensi nama koleksi:

  • orderscoll
  • tempCollection

Tip

Jika ada banyak koleksi dalam aplikasi, Anda cukup mengetikkan awalan di bilah rumus untuk melihat daftar koleksi yang tersedia. Adapun variabel, jika Anda mengikuti panduan ini untuk memberi nama koleksi, Anda dapat menemukannya dengan mudah di bilah rumus saat mengembangkan aplikasi. Pada akhirnya, pendekatan ini mengarah pada pengembangan aplikasi yang lebih cepat.

Komentar dan dokumentasi

Saat Anda menulis kode untuk aplikasi Anda, fokuslah untuk menambahkan komentar yang jelas. Komentar membantu Anda memahami kode nanti dan memudahkan developer berikutnya untuk mengerjakan proyek tersebut.

Power Apps mendukung dua gaya komentar untuk membuat kode Anda lebih jelas: Komentar baris, yang menggunakan garis miring ganda (//) untuk catatan satu baris, dan komentar blok, yang menggunakan /* dan */ untuk catatan multibaris.

Komentar baris

Tambahkan garis miring maju ganda (//) ke baris kode Power Apps mana pun untuk membuat sisa baris menjadi komentar.

Gunakan komentar baris untuk menjelaskan apa yang dilakukan baris kode berikutnya. Anda juga dapat menggunakannya untuk menonaktifkan sementara baris kode untuk pengujian.

Berikut adalah contoh komentar baris.

// ClearCollect function populates the Expenses2 collection with sample data
ClearCollect(
    Expenses2,
    // Entry 1: Client hosted meet and greet
    {
        Title: "Client hosted meet and greet:",
        ID: "4"
        // additional properties  
    }
)

Komentar blok

Teks antara /* dan */ adalah komentar blok. Komentar blok dapat mencakup beberapa baris, tidak seperti komentar baris, yang hanya mencakup satu baris.

AndaGunakan komentar blok untuk penjelasan yang lebih panjang, seperti mendokumentasikan header modul kode. Anda juga dapat menggunakannya untuk menonaktifkan sementara beberapa baris kode selama pengujian atau penelusuran kesalahan.

Untuk pengaturan kode yang lebih baik, tambahkan komentar setelah Anda menggunakan fitur Format Teks. Ini membantu jika komentar Anda muncul sebelum blok kode.

/*
    Patch Operation to Insert Data:
    - Inserts a new employee record into the 'Employee' entity.
    - Adds corresponding department details to the 'Department' entity.
    Note: Ensure that foreign key relationships and dependencies are maintained for data integrity.
*/
Patch(
    Employee,
    Defaults(Employee),
    {
        FirstName: "John",
        LastName: "Doe",
        Position: "Software Developer"
    }
)

Fitur Format Teks mengikuti aturan berikut untuk komentar:

  1. Jika properti dimulai dengan komentar blok, baris kode berikutnya akan ditambahkan ke dalamnya.
  2. Jika properti dimulai dengan komentar baris, baris kode berikutnya tidak ditambahkan ke dalamnya. Jika tidak, kode akan dikomentari.
  3. Komentar baris dan blok di tempat lain di properti ditambahkan ke baris kode sebelumnya.

Jangan khawatir menambahkan komentar terlalu banyak atau terlalu panjang. Power Apps menghapus semua komentar saat membuat paket aplikasi klien, sehingga komentar tidak memengaruhi ukuran paket atau memperlambat pengunduhan atau waktu pemuatan aplikasi.

Desainer aplikasi modern dengan komentar

Dalam Power Apps, yang terbaik adalah menggunakan fitur komentar baik di Power Apps Studio maupun Desainer aplikasi Modern.

Untuk menambahkan komentar di Power Apps Studio, gunakan metode berikut:

  1. Klik kanan elipsis ("...") dari item apa pun di Tampilan Hierarkis.
  2. Klik kanan komponen di area kanvas.
  3. Pilih tombol "Komentar" yang terletak di bilah perintah di sudut kanan atas layar.

Saat Anda menyebut kolega dalam komentar, gunakan simbol "@" diikuti dengan namanya. Ini mengirimkan email pemberitahuan ke orang yang Anda tandai. Jika pengguna yang ditandai tidak memiliki akses ke aplikasi, Power Apps meminta Anda untuk berbagi aplikasi dengan mereka.

Tangkapan layar aplikasi pengeluaran yang menunjukkan seseorang yang disebutkan dengan @ dalam komentar.

Indentasi dan pemformatan

Masuk Power Apps, indentasi dan pemformatan membantu menjaga aplikasi Anda tetap jelas dan teratur. Mengikuti praktik terbaik membuat rumus dan kontrol Anda lebih mudah dibaca.

Panel Rumus

Indentasi

Power Apps tidak memberlakukan indentasi yang ketat, tetapi Anda dapat menggunakan spasi untuk memisahkan bagian rumus yang berbeda. Tekan bilah spasi beberapa kali untuk membuat indentasi.

Jeda baris

Pecah rumus panjang menjadi beberapa baris agar lebih mudah dibaca. Tekan Enter untuk menambahkan jeda baris di bilah rumus.

Gunakan perintah Format teks

Perintah "Format Teks" di bilah rumus menambahkan indentasi, spasi, dan jeda baris ke kode Power Apps Anda. Gunakan perintah "Format Teks" untuk menjaga gaya pengkodean yang konsisten di aplikasi kanvas Anda dan membantu mencegah kesalahan.

Tangkapan layar Power Apps Studio dengan perintah Format Teks disorot.

Langkah selanjutnya

Pengoptimalan kode

  • Last updated on