Keterbacaan kode

Keterbacaan kode adalah aspek penting dari pengembangan aplikasi yang sering diabaikan. Kode yang dapat dibaca lebih mudah dipahami, dikelola, dan di-debug.

Konvensi penamaan

Konvensi penamaan yang konsisten secara signifikan meningkatkan keterbacaan kode Anda. Ini membantu Anda dengan cepat mengidentifikasi tujuan setiap elemen di aplikasi Anda dan membuatnya lebih mudah untuk menavigasi melalui basis kode Anda.

Konvensi penamaan umum

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

Kasus Camel

Gunakan 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.

Kasus Pascal

Gunakan kasus Pascal 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 Microsoft Office 365 Users, yang diberi nama Office365Users dalam kode.

Nama layar

Pilih nama layar yang dengan jelas menampilkan tujuan layar, yang memudahkan untuk menavigasi melalui aplikasi kompleks di Power Apps Studio.

Pembaca layar membacakan nama layar dengan keras. Pengguna dengan aksesibilitas visi perlu mengandalkan pembaca layar ini. Gunakan bahasa biasa untuk nama layar, sertakan spasi, dan hindari singkatan. Akhiri setiap nama dengan kata "Layar" untuk memberikan konteks yang jelas saat nama diumumkan.

Berikut adalah beberapa contoh yang bagus:

  • Home_Screen atau Home Screen
  • Search_Screen atau Search Screen

Cuplikan layar yang memperlihatkan 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. Mulailah dengan deskriptor jenis 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
Badge bdg
Tombol btn
Kontrol Kamera cam
Canvas dapat
Card crd
Grafik Chr
CheckBox chk
Collection col
Combo box cmb
Komponen cmp
Kontainer con
Tanggal dte
Drop-down drp
Form frm
Gallery gal
Kelompok grp
Header hdr
Teks Html htm
Icon ico
Gambar img
Tombol info info
Label lbl
Link lnk
Kotak daftar lst
Mikrofon mikrofon
Microsoft Stream str
Bentuk bagian halaman dtk
input pena pen
Ubin Power BI pbi
Panel Progres pbar
Penilaian rtg
Editor teks kaya rte
Bentuk (persegi panjang, lingkaran, dan sebagainya) shp
Penggeser sld
Daftar tab tab
Table tbl
Masukan Teks txt
Timer tmr
Pengalih tgl
Video vid

Daftar kontrol terperinci dan propertinya dijelaskan dalam Referensi kontrol.

Note

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.

Cuplikan layar tampilan navigasi memperlihatkan nama kontrol mengikuti pola yang dijelaskan.

Nama Sumber Data

Saat menambahkan sumber data ke aplikasi, Anda tidak dapat mengubah nama 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 dinamai Office365Users dalam kode Anda.
  • Entitas data yang berasal dari koneksi: sebuah daftar Microsoft SharePoint bernama Employees dikembalikan dari konektor SharePoint. Oleh karena itu, nama sumber data dalam kode Anda adalah Employees. 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.

Pelajari selengkapnya tentang konektor dan koneksi di Gambaran Umum konektor untuk aplikasi kanvas.

Konektor tindakan standar

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

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Konektor kustom

Gunakan konektor kustom untuk terhubung ke antarmuka pemrograman aplikasi kustom (API), seperti layanan atau API lini bisnis yang dibuat perusahaan Anda. Setiap pembuat di lingkungan Anda dapat membuat konektor kustom. Gunakan casing Pascal untuk nama sumber data dan operasinya. Nama konektor kustom dan cara munculnya di Power Apps dapat berbeda.

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

Cuplikan layar konektor bernama MS Auction Item Bid API.

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

Cuplikan layar konektor yang menunjukkan bahwa namanya adalah AuctionItemBidAPI.

Untuk menemukan alasannya, lihat 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

Ubah nilai atribut ini menjadi nama berkostum Pascal seperti AuctionItemBidAPI dan gunakan sebagai nama koneksi kustom Anda. Dengan cara ini, tidak ada kebingungan. Ubah nilai ini sebelum Anda mengimpor file OpenAPI untuk membuat konektor kustom.

Note

Jika Anda menggunakan opsi Buat dari kosong alih-alih mengimpor file OpenAPI yang ada, Power Apps akan meminta nama konektor kustom. Nama ini adalah nama konektor kustom dan nilai atribut judul di dalam file OpenAPI. Gunakan nama kasus Pascal seperti AuctionItemBidAPI untuk menjaga hal-hal tetap konsisten dan sederhana.

DataTables Excel

Power Apps menggunakan DataTable di Microsoft Excel untuk 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 ada di aplikasi Power Apps saat Anda menulis kode untuk menyambungkannya.
  • 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 dalam 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 umum 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. Contohnya:
    • 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, secara konsisten menggunakan userCount atau users.
  • Hindari menggunakan kata-kata cadangan atau nama yang mungkin berkonflik dengan fungsi atau kata kunci Power Apps. 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 memungkinkan variabel konteks dan variabel global memiliki nama yang sama. Berbagi ini dapat menyebabkan kebingungan karena rumus Anda menggunakan variabel konteks secara default kecuali Anda menggunakan operator disambiguasi.

Hindari situasi ini dengan mengikuti konvensi ini:

  • Variabel konteks awalan dengan loc.
  • Variabel global awalan dengan gbl.
  • Nama setelah awalan harus menunjukkan niat atau tujuan variabel. Anda dapat menggunakan beberapa kata tanpa perlu memisahkannya dengan karakter khusus, seperti garis bawah, jika Anda mengkapitalisasi huruf pertama dari setiap kata.
  • 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 kriptik seperti EID. Gunakan EmployeeId sebagai gantinya.

Saat aplikasi memiliki banyak variabel, ketik 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 dan lebih efisien.

Nama kumpulan

  • Gunakan nama yang menjelaskan konten koleksi. Pikirkan tentang apa yang dikandung koleksi dan cara penggunaannya, dan beri nama yang sesuai.
  • Awali nama koleksi dengan col.
  • Gunakan nama setelah awalan untuk menunjukkan niat atau tujuan koleksi. Anda dapat menggunakan beberapa kata tanpa spasi atau garis bawah di antara kata-kata jika Anda menggunakan huruf kapital pada huruf pertama setiap kata.
  • Gunakan camel casing. Mulai nama koleksi Anda dengan awalan huruf col kecil, lalu kapitalkan huruf pertama setiap kata dalam nama.

Contoh ini mengikuti konvensi nama koleksi:

  • colMenuItems
  • colThriveApps

Contoh ini tidak mengikuti konvensi nama koleksi:

  • orderscoll
  • tempCollection

Tip

Saat aplikasi memiliki banyak koleksi, ketik awalan di bilah rumus untuk melihat daftar koleksi yang tersedia. Jika Anda mengikuti panduan ini untuk memberi nama koleksi, Anda dapat dengan mudah menemukannya di bilah rumus saat mengembangkan aplikasi. 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 mempermudah pengembang berikutnya untuk mengerjakan proyek.

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

Komentar baris

Tambahkan garis miring ganda (//) ke baris kode apa pun di Power Apps untuk membuat baris lainnya 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. Pendekatan ini membantu ketika 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. Komentar tidak memengaruhi ukuran paket, kecepatan pengunduhan aplikasi, atau waktu pemuatan.

Desainer aplikasi modern dengan komentar

Di Power Apps, gunakan fitur komentar di Power Apps Studio dan perancang aplikasi modern.

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

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

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

Cuplikan layar aplikasi pengeluaran menampilkan seseorang yang disebutkan dengan @ dalam komentar.

Indentasi dan pemformatan

Indentasi dan pemformatan membantu menjaga aplikasi Anda tetap jelas dan terorganisir. Saat kode Anda diformat dengan baik, lebih mudah dibaca dan dipahami.

Indentasi

Power Apps tidak memerlukan indentasi yang ketat. Gunakan spasi untuk memisahkan bagian berbeda dari rumus Anda. 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 hentian baris ke kode Power Apps Anda. Gunakan perintah Format teks untuk mempertahankan gaya pengkodian yang konsisten di aplikasi kanvas Anda dan untuk membantu mencegah kesalahan.

Cuplikan layar Power Apps Studio dengan perintah Format teks disorot.

Langkah selanjutnya

Pengoptimalan kode

  • Last updated on