Kod okunabilirliği

Adlandırma kuralları

Genel adlandırma kuralları

Bu bölümde, "camel harflendirme" ve "Pascal harflendirme" adlandırma kuralları açıklanmaktadır. Bu terimleri zaten biliyorsanız bölüm atlayabilirsiniz.

Camel harflendirme

Denetimler ve değişkenler için camel harflendirme kullanmanız gerekir. 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 harflendirme kullanmanız gerekir. 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 harflendirme aksine Pascal harflendirme'te ilk sözcük de büyük harfle başlar. Örneğin, PowerApps'te ortak bir veri kaynağı, kodunuzda 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 uygulamalar arasında gezinmeyi kolaylaştırmak için ekran adları ekranın amacını yansıtmalıdır.

Daha az belirgin olan ise ekran adlarının, görsel erişilebilirlik ihtiyaçları olan kullanıcılar için gerekli olan ekran okuyucular tarafından yüksek sesle okunmasıdır. Bu nedenle ekranlarınızı adlandırırken sade bir dil kullanmanız ve adların boşluk içermesi ve kısaltma içermemesi zorunludur. Ayrıca ad duyurulduğunda bağlamın anlaşılabilmesi için adı "Ekranı" sözcüğüyle bitirmenizi öneririz.

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

• Home_Screen veya Home Screen
• Search_Screen veya Search Screen

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

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Denetim adları

Tuvaldeki tüm denetim adlarında camel harflendirme kullanılmalıdır. Üç karakterli bir tanımlayıcıyla başlamalıdırlar ve ardından denetimin amacı gelmelidir. 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
Rozet	bdg
Button	btn
Kamera denetimi	cam
Tuval	can
Card	crd
Grafikler	chr
CheckBox	chk
Koleksiyon	col
Birleşik giriş kutusu	cmb
Bileşen	cmp
Kapsayıcı	con
Tarihler	dte
Açılan liste	drp
Şekil	frm
Galeri	gal
Gruplandırma	grp
Üst bilgi	hdr
Html metni	htm
Icon	ico
Görsel	img
Bilgi Düğmesi	bilgileri
Label	lbl
Bağlantı ekleyin	lnk
Liste kutusu	lst
Mikrofon	mic
Microsoft Stream	str
Sayfa bölümü şekli	sn.
Kalem Girişi	pen
Power BI Kutucuğu	pbi
İlerleme Çubuğu	pbar
Rating	rtg
Zengin metin düzenleyicisi	rte
Şekiller (dikdörtgen, daire vb.)	shp
Kaydırıcı	sld
Sekme Listesi	tbl
Table	tbl
Metin girişi	txt
Zamanlayıcı	tmr
Geçiş düğmesi	tgl
Görüntülü	vid

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

Not

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 gezinti görünümünde uygulamanız ve ayrıca kodunuz net olur.

Veri kaynağı adları

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

İşte bazı örnekler:

• Kaynak bağlayıcıdan türetilen ad: Kodunuzda Office 365 Kullanıcıları bağlayıcısı namedOffice365Users şeklindedir.
• 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ı Employees şeklindedir. Aynı Power Apps uygulaması, adlı bir SharePoint listesine erişmek için da kullanabilir. Bu durumda, koddaki veri kaynağının adı Contractors şeklindedir.

Bağlayıcılar ve bağlantılar hakkında daha fazla bilgi için bkz. Power Apps için tuval uygulaması bağlayıcılarına genel bakış.

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 için Pascal harflendirme kullanılır. Örneğin, LinkedIn veri kaynağı LinkedIn olarak adlandırılır ve burada ListCompanies adlı bir işlem vardır.

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 kullanılan özel bağlayıcılar. Bunlar, ortamınızdaki oluşturucular tarafından oluşturulabilir. Veri kaynağı adı ve işlemleri için Pascal harflendirme kullanmanızı öneririz. Özel bağlayıcı adının ve PowerApps'te görünme biçiminin farklılık gösterebileceğini unutmayın.

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

Ancak bu bağlayıcıdan bir bağlantı oluşturup bunu PowerApps uygulamanıza veri kaynağı olarak eklediğinizde AuctionItemBidAPI olarak görüntülenir.

Nedenini keşfetmek için OpenAPI dosyasının içinde Auction Item Bid API metnini içeren bir başlık özniteliğine bakabilirsiniz.

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

Power Apps, bu öznitelik değerinden tüm alanları kaldırır ve özniteliği veri kaynağınızın adı olarak kullanır.

İpucu

Bu özniteliğin değerini AuctionItemBidAPI gibi Pascal harflendirme adla değiştirmenizi ve bunu özel bağlantınızın adı olarak kullanmanızı öneririz. Böylece 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.

Not

Mevcut OpenAPI dosyasını içeri aktarmak yerine Sıfırdan oluştur seçeneğini kullanırsanız PowerApps'te sizden özel bağlayıcı adını istenir. Bu ad, özel bağlayıcının adı ve OpenAPI dosyası içindeki başlık özniteliğinin değeri olarak kullanılır. Öğeleri tutarlı ve basit tutmak için AuctionItemBidAPI gibi Pascal harflendirme bir ad kullandığınızdan emin olun.

Excel Veri Tabloları

PowerApps'te, Excel çalışma sayfalarındaki verilere bağlanmak için Microsoft Excel'deki Veri Tabloları kullanılı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 kod yazdığınızda ad, Power Apps uygulaması içindedir.
• 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 harflendirme 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. Temp veya var1 gibi çok genel adlardan kaçının. Bunun yerine, userEmail veya totalAmount gibi 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ı olarak 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 denetleyin.
• 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. Formüllerinizde varsayılan olarak bağlam değişkenleri kullanıldığından bu durum, kesinleştirme işleci kullanılmadıkça karışıklığa neden olabilir.

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

• Bağlam değişkenleri için loc önekini ekleyin.
• Genel değişkenler için gbl önekini ekleyin.
• Önekten sonraki ad, değişkenin amacını belirtmelidir. Birden fazla sözcük kullanılabilir ve her sözcüğün ilk harfi büyük harf olduğunda sözcüklerin boşluk veya alt çizgi gibi özel karakterlerle ayrılması gerekmez.
• Camel harflendirme 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

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

Uygulamada çok sayıda değişken olduğunda mevcut değişkenlerin listesini görmek için formül çubuğuna öneki yazabilirsiniz. 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ı uygulama geliştirmeye yol açar.

Koleksiyon adları

• Koleksiyonun içeriğini açıklayın. Koleksiyonun neleri içerdiğini ve/veya nasıl kullanıldığını düşünün ve koleksiyonu buna göre adlandırın.
• Koleksiyonlarda, col şeklinde önek kullanılmalıdır.
• Önekten sonraki ad, koleksiyonun amacını belirtmelidir. Birden fazla sözcük kullanılabilir ve her sözcüğün ilk harfi büyük harf olduğunda sözcüklerin boşluk veya alt çizgi ile ayrılması gerekmez.
• Camel harflendirme kullanın. Koleksiyon adlarınıza küçük harfli col öneki ile başlayın ve ardından addaki her sözcüğün ilk harfini büyük harf yapın.

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

• colMenuItems
• colThriveApps

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

• orderscoll
• tempCollection

İpucu

Uygulamada çok sayıda koleksiyon olduğunda mevcut koleksiyonların listesini görmek için formül çubuğuna öneki yazabilirsiniz. Değişkenlere gelince, koleksiyonlarınızı 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ı uygulama geliştirmeye yol açar.

Yorumlar ve belgeler

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

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, yorumlarınız bir kod bloğundan önce geliyorsa 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 yorumları kaldırır, böylece yorumlar paket boyutunu etkilemez veya uygulama indirme veya yükleme sürelerini yavaşlatmaz.

Yorumlarla modern uygulama tasarımcısı

Power Apps'de, hem Power Apps Studio'deki hem de Modern uygulama tasarımcısındaki yorumlama özelliklerini kullanmak en iyisidir.

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

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

Bir yorumda bir iş arkadaşınızdan bahsettiğinizde, "@" sembolünü ve ardından adını kullanın. Bu işlem, 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.

Girintilendirme ve biçimlendirme

Power Apps'de girinti ve biçimlendirme uygulamanızın açık ve düzenli kalmasına yardımcı olur. En iyi uygulamaları takip etmek, formüllerinizin ve denetimlerinizin daha kolay okunmasını sağlar.

Formül çubuğu

Girintilendirme

Power Apps kesin girintiyi zorlamaz, ancak formüllerinizin farklı bölümlerini ayırmak için boşluk kullanabilirsiniz. Girinti oluşturmak için boşluk ç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 kodunuza girinti, boşluk ve satır sonları ekler. Tuval uygulamanızda tutarlı bir kodlama stili sağlamak ve hataları önlemeye yardımcı olmak için "Metni Biçimlendir" komutunu kullanın.

Sonraki adım

Kod iyileştirme