Kod okunabilirliği

Kod okunabilirliği, uygulama geliştirmenin genellikle göz ardı edilen önemli bir yönüdür. Okunabilir kodu anlamak, korumak ve hatalarını ayıklamak daha kolaydır.

Adlandırma kuralları

Tutarlı adlandırma kuralları kodunuzun okunabilirliğini önemli ölçüde artırır. Uygulamanızdaki her öğenin amacını hızla belirlemenize yardımcı olur ve kod tabanınızda gezinmeyi kolaylaştırır.

Genel adlandırma kuralları

Bu bölümde "camelCase" ve "PascalCase" adlandırma kuralları açıklanmaktadır. Bu terimleri zaten biliyorsanız bölüm atlayabilirsiniz.

Deve olayı

Denetimler ve değişkenler için camelCase stilini kullanın. Camel harflendirme küçük harfli bir önekle başlar, nesne veya değişken adlarındaki tüm boşluklar kaldırılır ve ilk sözcükten sonra her sözcüğün ilk harfi büyük harf yapılır. Örneğin, bir metin giriş denetimi txtUserEmailAddress olarak adlandırılabilir.

Pascal harflendirme

Veri kaynakları için Pascal biçimini kullanın. Pascal durumu yazımı bazen "üst deve yazımı" olarak adlandırılır. Deve yazımı gibi, tüm boşlukları kaldırır ve kelimelerin ilk harfini büyük yazar. Ancak camel case aksine, Pascal case'de ilk sözcük de büyük harfle başlar. Örneğin, Power Apps'teki yaygın bir veri kaynağı, kodda Office365Users olarak adlandırılan Microsoft Office 365 Kullanıcıları bağlayıcısıdır.

Ekran adları

Power Apps Studio'daki karmaşık uygulamalarda gezinmeyi kolaylaştıran, ekranın amacını açıkça gösteren ekran adlarını seçin.

Ekran okuyucular ekran adlarını yüksek sesle okur. Görme erişilebilirliği gereksinimleri olan kullanıcılar bu ekran okuyucuları temel alır. Ekran adları için düz dil kullanın, boşluk ekleyin ve kısaltmalardan kaçının. Ad duyurulduğunda net bir bağlam sağlamak için her adı "Ekran" sözcüğüyle sonlandırın.

Aşağıda bazı uygun örnekler yer almaktadır:

  • Home_Screen veya Home Screen
  • Search_Screen veya Search Screen

Açıklanan deseni izleyen ekran adlarının listesini gösteren ekran görüntüsü.

Bu örnek ekran adları daha az anlaşılırdır:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Denetim adları

Tuvaldeki tüm denetim adları için camel case kullanın. Üç karakterli bir tür tanımlayıcısı ile başlayın ve ardından denetimin amacını belirleyin. Bu yaklaşım, denetimin türünün belirlenmesine yardımcı olur ve formül oluşturmayı ve aramayı kolaylaştırır. Örneğin, lblUserName ile denetimin bir etiket olduğu belirtilmektedir.

Aşağıdaki tabloda, yaygın denetimlerin kısaltmaları gösterilmektedir.

Denetim adı Kısaltma
Badge bdg
Düğme btn
Kamera denetimi cam
Tuval can
Kart crd
Grafikler Chr
CheckBox chk
Koleksiyon col
Açılan kutu cmb
Bileşen cmp
Konteyner con
Tarihler dte
Açılır menü drp
Form frm
Gallery gal
Grup grp
Başlık hdr
Html metni htm
Icon ico
Resim img
Bilgi Düğmesi Bilgi
Etiket lbl
Bağlantı lnk
Liste kutusu lst
Mikrofon mic
Microsoft Stream str
Sayfa bölümü şekli saniye
Kalem Girişi kalem
Power BI Kutucuğu pbi
İlerleme Çubuğu pbar
Derecelendirme rtg
Zengin metin düzenleyicisi rte
Şekiller (dikdörtgen, daire vb.) shp
Kaydırıcı sld
Sekme Listesi sekme
Tablo tbl
Metin girişi txt
Timer tmr
Geçiş düğmesi tgl
Video vid

Ayrıntılı denetim listesi ve bunların özellikleri, Denetimler başvurusu bölümünde açıklanmaktadır.

Uyarı

Denetim adları, uygulama genelinde benzersiz olmalıdır. Denetim birden çok ekranda yeniden kullanılıyorsa kısa ekran adının sonek olması gerekir. Örneğin, "HS"nin "Ana Ekran" anlamına geldiği galBottomNavMenuHS. Bu yaklaşım, formüllerde kontrole ekranlar arasında başvurmayı kolaylaştırır.

Aşağıda bazı uygunsuz örnekler yer almaktadır:

  • zipcode
  • Next

Denetimlerinizi tutarlı şekilde adlandırdığınızda, uygulamanızın gezinti görünümü ve kodunuz daha temiz olur.

Açıklanan deseni izleyen denetim adlarının gezinti görünümünde gösterildiği ekran görüntüsü.

Veri kaynağı adları

Uygulamanıza veri kaynağı eklediğinizde, Power Apps uygulamasında adı değiştiremezsiniz. Ad, kaynak bağlayıcıdan veya bağlantıdan türetilen veri varlıklarından devralınır.

Burada bazı örnekler verilmiştir:

  • Kaynak bağlayıcıdan devralınan ad: Office 365 Kullanıcıları bağlayıcısı kodunuzda Office365Users olarak adlandırılır.
  • Bağlantıdan türetilen veri varlıkları:Employees adlı Microsoft SharePoint listesi, SharePoint bağlayıcısından döndürülür. Bu nedenle, kodunuzdaki veri kaynağının adı şeklindedir Employees. Aynı Power Apps uygulaması, aynı SharePoint konektörünü, adlı bir SharePoint listesine erişmek için de kullanabilir. Bu durumda, koddaki veri kaynağının adı Contractors şeklindedir.

Tuval uygulamaları için bağlayıcılara genel bakış bölümünde bağlayıcılar ve bağlantılar hakkında daha fazla bilgi edinin.

Standart eylem bağlayıcıları

LinkedIn gibi işlevleri kullanıma sunan standart eylem bağlayıcılarında, veri kaynağı adı ve işlemleri Pascal büyük/küçük harf kullanımıyla yazılır. Örneğin, LinkedIn veri kaynağı LinkedIn olarak adlandırılır ve ListCompanies adlı bir işleme sahiptir.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Özel bağlayıcılar

Şirketinizin oluşturduğu hizmetler veya iş kolu API'leri gibi özel uygulama programlama arabirimlerine (API' ler) bağlanmak için özel bağlayıcılar kullanın. Ortamınızdaki herhangi bir oluşturucu özel bağlayıcılar oluşturabilir. Veri kaynağı adı ve işlemleri için Pascal kasasını kullanın. Özel bağlayıcı adı ve Power Apps'te görüntülenme biçimi farklılık gösterebilir.

MS Auction Item Bid API adlı bu özel bağlayıcı örneğine dikkat edin.

MS Auction Item Bid API adlı bağlayıcının ekran görüntüsü.

Bu bağlayıcıdan bir bağlantı oluşturduğunuzda ve bunu Power Apps uygulamanıza veri kaynağı olarak eklediğinizde, AuctionItemBidAPI olarak görünür.

Adın AuctionItemBidAPI olduğunu gösteren bağlayıcının ekran görüntüsü.

Nedenini bulmak için OpenAPI dosyasının içinde metnini Auction Item Bid APIiçeren başlık özniteliğine bakın.

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

Power Apps bu öznitelik değerindeki tüm boşlukları kaldırır ve veri kaynağınızın adı olarak kullanır.

Tip

Bu özniteliğin değerini AuctionItemBidAPI örneğinde olduğu gibi Pascal Biçimlendirmesi kullanarak değiştirin ve kendi özel bağlantınızın adı olarak kullanın. Bu şekilde karışıklık olmaz. Özel bağlayıcıyı oluşturmak için OpenAPI dosyasını içeri aktarmadan önce bu değeri değiştirin.

Uyarı

Mevcut bir OpenAPI dosyasını içeri aktarmak yerine Boş bir dosyadan oluştur seçeneğini kullanırsanız, Power Apps sizden özel bağlayıcı adını ister. Bu ad hem özel bağlayıcının adı hem de OpenAPI dosyasının içindeki title özniteliğinin değeridir. Tutarlılık ve basitlik için Pascal büyük/küçük harf kullanımlı AuctionItemBidAPI gibi bir ad kullanın.

Excel Veri Tabloları

Power Apps, Excel çalışma sayfalarındaki verilere bağlanmak için Microsoft Excel'deki DataTable'ları kullanır. Veri kaynağı olarak Excel belgeleri oluştururken şu noktaları aklınızda bulundurun:

  • Veri Tablolarınıza açıklayıcı adlar verin. Bağlanmak için kodu yazdığınızda ad Power Apps uygulamasında yer alır.
  • Her çalışma sayfası için bir Veri Tablosu kullanın.
  • Veri Tablosu ve çalışma sayfasına aynı adı verin.
  • Veri Tablolarında açıklayıcı sütun adları kullanın.
  • Pascal Case kullanın. Veri Tablosu adında her sözcüğün, EmployeeLeaveRequests gibi büyük harfle başlaması gerekir.

Değişken adları

Tuval uygulamalarındaki değişkenlere yönelik adlandırma kuralları, Power Apps projelerinizde okunabilirliği, tutarlılığı ve netliği korumak için önemlidir. Katı bir standart uygulanmasa da, tuval uygulaması genelinde tutarlı bir adlandırma kuralı benimsemek, sizin ve diğer ortak çalışanların değişkenleri anlamasını, kullanmasını ve yönetmesini kolaylaştırabilir.

  • İlk sözcük haricisinde her sözcüğün ilk harfinin büyük harf olduğu camel harflendirme kullanın.
  • Değişkenin amacını veya içeriğini açıkça tanımlayan anlamlı ve açıklayıcı adlar seçin. veya tempgibi var1 fazla genel adlardan kaçının. Bunun yerine veya userEmailgibi totalAmount açıklayıcı adlar kullanın.
  • Değişkenin türünü belirtmek için önekler veya sonekler kullanmayı düşünün. Örneğin:
    • Metin/dize değişkeni için strUserName
    • Sayısal bir değişken için numTotalAmount
    • Boole değişkeni için boolIsEnabled
    • Yerel değişkenler/bağlam değişkenleri için locVarName
    • Genel değişkenler için gblVarLoginUser
  • Değişkenlerinizin tekil veya çoğul biçimde adlandırılması gerekip gerekmediğine karar verin ve bu kurala bağlı kalın. Örneğin, tutarlı bir şekilde userCount veya users kullanın.
  • Power Apps işlevleri veya anahtar sözcükleriyle çakışabilecek ayrılmış sözcükleri veya adları kullanmaktan kaçının. Ayrılmış sözcükler listesi için Power Apps belgelerini kontrol edin.
  • Değişkenin kullanımı veya kapsamı hakkında bağlam sağlayan önekler kullanmayı düşünün. Örneğin:
    • Form değişkenleri için frm
    • Koleksiyonlar için col
    • Genel amaçlı değişkenler için var
  • Özel karakterlerden kaçının. Alfasayısal adları koruyun ve özel karakterlerden veya boşluklardan kaçının. Yalnızca harfleri ve sayıları kullanın.

Power Apps, bağlam değişkenlerinin ve genel değişkenlerin aynı adları paylaşmasına olanak tanır. Bu paylaşım karışıklığa neden olabilir çünkü siz kesinleştirme işlecini kullanmadığınız sürece formülleriniz varsayılan olarak bağlam değişkenlerini kullanır.

Aşağıdaki kuralları izleyerek bu durumdan kaçının:

  • loc önekiyle bağlam değişkenlerini belirtin.
  • Genel değişkenlere gbl önekini ekleyin.
  • Ön ekin ardından gelen ad, değişkenin amacını veya amacını göstermelidir. Her sözcüğün ilk harfini büyük harfe çevirirseniz, bunları alt çizgi gibi özel karakterlerle ayırmanıza gerek kalmadan birden çok sözcük kullanabilirsiniz.
  • Büyük/küçük harfleri karışık kullanın. Değişken adlarınıza küçük harflerin olduğu bir önek ile başlayın ve ardından addaki her sözcüğün ilk harfini büyük harf yapın.

Aşağıdaki örneklerde standartlar ve kurallar izlenmektedir:

  • Genel değişken:gblFocusedBorderColor
  • Bağlam değişkeni:locSuccessMessage
  • Kapsam değişkeni:scpRadius

Bu örnekler standartlara uymaz ve anlaşılması daha zordur:

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

gibi EIDkısa ve şifreli değişken adlarından kaçının. Bunun yerine EmployeeId kullanın.

Bir uygulamada çok sayıda değişken olduğunda, kullanılabilir değişkenlerin listesini görmek için formül çubuğuna ön eki yazın. Değişkenlerinizi adlandırmak için bu yönergeleri izlerseniz, uygulamanızı geliştirirken bunları formül çubuğunda kolayca bulabilirsiniz. Sonuç olarak, bu yaklaşım daha hızlı ve daha verimli uygulama geliştirmeye yol açar.

Koleksiyon adları

  • Koleksiyonun içeriğini açıklayan adları kullanın. Koleksiyonun ne içerdiğini ve nasıl kullanıldığını düşünün ve buna göre adlandırın.
  • Koleksiyon adlarının önüne col ekleyin.
  • Koleksiyonun niyetini veya amacını göstermek için ön ekin ardından gelen adı kullanın. Her sözcüğün ilk harfini büyük harfe çevirirseniz, boşluk veya alt çizgi olmadan birden çok sözcük kullanabilirsiniz.
  • Büyük/küçük harfleri karışık kullanın. Koleksiyon adlarınızı küçük col bir ön ek ile başlatın ve ardından addaki her sözcüğün ilk harfini büyük harfle yazın.

Aşağıdaki örneklerde koleksiyon adı kuralları izlenmektedir:

  • colMenuItems
  • colThriveApps

Aşağıdaki örneklerde koleksiyon adı kuralları izlenmemektedir:

  • orderscoll
  • tempCollection

Tip

Bir uygulamada çok sayıda koleksiyon olduğunda, kullanılabilir koleksiyonların listesini görmek için formül çubuğuna ön eki yazın. Koleksiyonlarınızı adlandırmak için bu yönergeleri izlerseniz, uygulamanızı geliştirirken bunları formül çubuğunda kolayca bulabilirsiniz. Bu yaklaşım daha hızlı uygulama geliştirmeye yol açar.

Yorumlar ve belgeler

Uygulamanız için kod yazarken, net yorumlar eklemeye odaklanın. Açıklamalar, kodu daha sonra anlamanıza ve bir sonraki geliştiricinin proje üzerinde çalışmasını kolaylaştırmaya yardımcı olur.

Power Apps kodunuzu daha anlaşılır hale getirmek için iki yorum stilini destekler: tek satırlık notlar için çift eğik çizgi (//) kullanan satır yorumları ve çok satırlı notlar için /* ve */ kullanan blok yorumları.

Satır yorumları

Power Apps'deki herhangi bir kod satırına çift eğik çizgi (//) ekleyerek satırın geri kalanını yorum haline getirin.

Bir sonraki kod satırının ne yaptığını açıklamak için satır yorumlarını kullanın. Bunları, test için bir kod satırını geçici olarak devre dışı bırakmak için de kullanabilirsiniz.

İşte bir satır yorumu örneği.

// 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  
    }
)

Blok yorumları

/* ile */ arasındaki metin blok yorumdur. Blok yorumları, yalnızca bir satırı kapsayan satır yorumlarının aksine birkaç satırı kapsayabilir.

Kod modülü başlığını belgelemek gibi daha uzun açıklamalar için blok yorumlarını kullanın. Bunları, test veya hata ayıklama sırasında birkaç kod satırını geçici olarak devre dışı bırakmak için de kullanabilirsiniz.

Daha iyi kod organizasyonu için, Metni Biçimlendir özelliğini kullandıktan sonra yorumlar ekleyin. Bu yaklaşım, açıklamalarınızın bir kod bloğunun önünde görünmesine yardımcı olur.

/*
    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"
    }
)

Metni Biçimlendir özelliği, yorumlar için şu kurallara uyar:

  1. Bir özellik bir blok yorumu ile başlıyorsa, bir sonraki kod satırı buna eklenir.
  2. Eğer bir özellik bir satır yorumuyla başlıyorsa, bir sonraki kod satırı buna eklenmez. Aksi takdirde, koda yorum eklenir.
  3. Özelliğin başka bir yerindeki satır ve blok açıklamaları önceki kod satırına eklenir.

Çok fazla veya çok uzun yorum ekleme konusunda endişelenmeyin. Power Apps, istemci uygulama paketini oluşturduğunda tüm açıklamaları kaldırır. Açıklamalar paket boyutunu, uygulama indirme hızını veya yükleme sürelerini etkilemez.

Yorumlarla modern uygulama tasarımcısı

Power Apps'te hem Power Apps Studio'daki hem de modern uygulama tasarımcısındaki yorum özelliklerini kullanın.

Power Apps Studio'e yorum eklemek için şu yöntemleri kullanın:

  • Ağaç Görünümünde öğelerde üç noktaya ("...") sağ tıklayın.
  • Tuval alanındaki bir bileşene sağ tıklayın.
  • Ekranın sağ üst köşesindeki komut çubuğunda bulunan Açıklamalar düğmesini seçin.

Bir yorumda bir iş arkadaşınızdan bahsettiğinizde, "@" sembolünü ve ardından adını kullanın. Bu eylem, etiketlediğiniz kişiye bir bildirim e-postası gönderir. Etiketlenen kullanıcının uygulamaya erişimi yoksa Power Apps, uygulamayı onunla paylaşmanızı ister.

Yorumda @ ile bahsedilen bir kişiyi gösteren bir gider uygulamasının ekran görüntüsü.

Girintilendirme ve biçimlendirme

Girintileme ve biçimlendirme, uygulamanızın temiz ve düzenli kalmasına yardımcı olur. Kodunuz iyi biçimlendirildiğinde okunup anlaşılması daha kolaydır.

Girinti

Power Apps, katı girinti kuralları uygulamaz. Formüllerinizin farklı bölümlerini ayırmak için boşluk kullanın. Girinti oluşturmak için ara çubuğuna birkaç kez basın.

Satır sonları

Okunmalarını kolaylaştırmak için uzun formülleri birden çok satıra bölün. Formül çubuğuna satır sonu eklemek için Enter tuşuna basın.

Metni biçimlendir komutunu kullanma

Formül çubuğundaki Metni biçimlendir komutu Power Apps kodunuz için girinti, aralık ve satır sonları ekler. Tuval uygulamanızda tutarlı bir kodlama stilini korumak ve hataları önlemeye yardımcı olmak için Metni biçimlendir komutunu kullanın.

Metni biçimlendir komutunun vurgulandığı Power Apps Studio'nun ekran görüntüsü.

Sonraki adım

Kod iyileştirme

  • Last updated on