Kodo skaitomumas

Pavadinimų suteikimo konvencijos

Bendrosios vardų suteikimo konvencijos

Šiame skyriuje aprašomos "kupranugario atvejis" ir "Paskalio atvejis" pavadinimų suteikimo konvencijos. Jei jau esate susipažinę su šiomis sąlygomis, galite praleisti į priekį.

Kupranugario atvejis

Valdikliams ir kintamiesiems turėtumėte naudoti kupranugario dėklą. Kupranugario didžiosios raidės prasideda mažosiomis raidėmis, pašalina visus tarpus iš objektų ar kintamųjų pavadinimų ir rašo kiekvieno žodžio pirmąją raidę po pirmosios. Pavyzdžiui, teksto įvesties valdiklis gali būti pavadintas txtUserEmailAddress.

Paskalio atvejis

Duomenų šaltiniams turėtumėte naudoti Pascal atvejį. Paskalio atvejis kartais vadinamas "didžiuoju kupranugario atveju". Kaip ir kupranugario atvejis, jis pašalina visus tarpus ir rašo pirmąją žodžių raidę didžiosiomis raidėmis. Tačiau, skirtingai nei kupranugarių atveju, Paskalio atvejis taip pat rašo pirmąjį žodį didžiąja raide. Pavyzdžiui, įprastas duomenų šaltinis PowerApps yra Microsoft Office 365 jungtis Vartotojai, kurios kodas pavadintas "Office365Users".

Ekrano pavadinimai

Ekrano pavadinimai turėtų atspindėti ekrano paskirtį, kad būtų lengviau naršyti sudėtingose programose Power Apps Studio.

Mažiau akivaizdu yra tai, kad ekrano skaitytuvai garsiai skaito ekrano pavadinimus, kurie reikalingi vartotojams, turintiems regėjimo pritaikymo neįgaliesiems poreikių. Todėl būtina, kad pavadindami ekranus naudotumėte paprastą kalbą ir kad pavadinimuose būtų tarpai ir nebūtų santrumpų. Be to, rekomenduojame pavadinimą baigti žodžiu "Ekranas", kad skelbiant pavadinimą būtų suprantamas kontekstas.

Štai keletas gerų pavyzdžių:

• Home_Screen arba Home Screen
• Search_Screen arba Search Screen

Šie ekrano pavadinimų pavyzdžiai yra mažiau suprantami:

• Home
• LoaderScreen
• EmpProfDetails
• Thrive Help

Valdo pavadinimus

Visi kontroliniai pavadinimai ant drobės turėtų naudoti kupranugario dėklą. Jie turėtų prasidėti trijų simbolių tipo deskriptoriumi, po kurio turėtų būti nurodytas kontrolės tikslas. Šis metodas padeda nustatyti valdiklio tipą ir palengvina formulių kūrimą bei iešką. Pavyzdžiui, nurodo, lblUserName kad valdiklis yra etiketė.

Šioje lentelėje pateikiamos bendrųjų valdiklių santrumpos.

Valdiklio pavadinimas	Santrumpa
Ženklelis	BDG
Button	btn
Kameros valdymas	Kamera
Drobė	galėti
Card	Krd
Diagramos	Šv.
Žymimasis laukelis	CHK
Rinkinys	Col
Pasirinktinio įvedimo laukas	cmb
Komponentas	CMP
Konteineris	Con
Datos	Dte
Išplečiamasis	DRP
Forma	FRM
Galerija	galas
Grupuoti	grp
Antraštė	Hdr
Html tekstas	htm
Icon	ICO
Image	img
Informacijos mygtukas	informacija
Label	Lkl
Susieti	lnk
Sąrašo laukas	LT
Mikrofonas	mikrofonas
Microsoft Stream	Str
Puslapio sekcijos forma	sek.
Rašiklio įvestis	tušinukas
„Power BI“ plytelė	PBI
Eigos juosta	pbar
Rating	Rtg
Raiškiojo teksto rengyklė	Rte
Figūros (stačiakampis, apskritimas ir pan.)	Shp
Slankiklis	SLD
Skirtukų sąrašas	TBL
Table	TBL
Teksto įvestis	txt
Laikmatis	TMR
Perjungiklis	TGL
Video	vid.

Išsamus valdiklių ir jų ypatybių sąrašas aprašytas valdiklių nuorodoje.

Pastaba.

Valdiklių pavadinimai turi būti unikalūs visoje programoje. Jei valdiklis pakartotinai naudojamas keliuose ekranuose, trumpojo ekrano pavadinime turėtų būti priesaga. Pavyzdžiui, galBottomNavMenuHS kur "HS" reiškia "Pagrindinis ekranas". Šis metodas leidžia lengviau nurodyti valdiklį formulėse visuose ekranuose.

Štai keletas blogų pavyzdžių:

• zipcode
• Next

Kai nuosekliai pavadinate valdiklius, jūsų programa yra švaresnė naršymo rodinyje, o kodas taip pat yra švaresnis.

Duomenų šaltinių pavadinimai

Kai į programą įtraukiate duomenų šaltinį, pavadinimo programoje keisti Power Apps negalima. Pavadinimas paveldimas iš šaltinio jungties arba duomenų objektų, gautų iš ryšio.

Štai keli pavyzdžiai:

• Pavadinimas paveldėtas iš šaltinio jungties: Jungtis Office 365 Vartotojai jūsų kode pavadintaOffice365Vartotojai.
• Duomenų objektai, gauti iš ryšio: Pavadintas SharePoint "Microsoft" Employees sąrašas grąžinamas SharePoint iš jungties. Todėl jūsų kodo duomenų šaltinio pavadinimas yra Darbuotojai. Ta pati Power Apps programa taip pat gali naudoti tą pačią SharePoint jungtį , kad pasiektų SharePoint pavadintą Contractors sąrašą. Tokiu atveju kodo duomenų šaltinio pavadinimas yra Contractors.

Daugiau informacijos apie jungtis ir jungtis rasite drobės programų jungčių Power Apps apžvalga.

Standartinės veiksmo jungtys

Standartinio veiksmo jungtyse, kurios atskleidžia funkcijas, pvz., "LinkedIn", duomenų šaltinio pavadinimas ir jo operacijos naudoja "Pascal" korpusą. Pavyzdžiui, "LinkedIn" duomenų šaltinis pavadintas "LinkedIn" ir jo operacija pavadinta ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Pasirinktinės jungtys

Pasirinktinės jungtys, naudojamos prisijungti prie pasirinktinių taikomųjų programų programavimo sąsajų (API), pvz., paslaugų ar verslo srities API, kurias sukūrė jūsų įmonė. Juos gali sukurti bet kuris jūsų aplinkos kūrėjas. Duomenų šaltinio pavadinimui ir jo operacijoms rekomenduojame naudoti "Pascal" korpusą. Tiesiog atminkite, kad pasirinktinis jungties pavadinimas ir būdas, kuriuo jis rodomas PowerApps , gali skirtis.

Apsvarstykite šį pasirinktinės jungties, pavadintos MS Auction Item Bid API, pavyzdį.

Tačiau kai sukuriate ryšį naudodami šią jungtį ir pridedate jį prie PowerApps programos kaip duomenų šaltinį, jis rodomas kaip AuctionItemBidAPI.

Norėdami sužinoti priežastį, failo viduje OpenAPI galite ieškoti pavadinimo atributo, kuriame yra tekstas Auction Item Bid API.

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

Power Apps Pašalina visus tarpus iš šios atributo reikšmės ir naudoja ją kaip duomenų šaltinio pavadinimą.

Arbatpinigiai

Rekomenduojame pakeisti šio atributo reikšmę į vardą su paskaliais, pvz., AuctionItemBidAPI ir naudoti jį kaip pasirinktinio ryšio pavadinimą. Tokiu būdu nebus painiavos. Pakeiskite šią reikšmę prieš importuodami failą, OpenAPI kad sukurtumėte pasirinktinę jungtį.

Pastaba.

Jei naudosite parinktį Kurti iš tuščios , o ne importuosite esamą OpenAPI failą, PowerApps būsite paraginti įvesti pasirinktinės jungties pavadinimą. Šis pavadinimas bus naudojamas ir kaip pasirinktinės jungties pavadinimas, ir kaip pavadinimo atributo reikšmė faile OpenAPI . Būtinai naudokite Paskalio pavadinimą, AuctionItemBidAPI kad viskas būtų nuoseklu ir paprasta.

"Excel" duomenų lentelės

PowerApps naudoja Microsoft Excel duomenų lenteles, kad prisijungtų prie "Excel" darbalapių duomenų. Kurdami "Excel" dokumentus kaip duomenų šaltinius, atminkite šiuos dalykus:

• Suteikite savo DataTables aprašomuosius pavadinimus. Pavadinimas yra programoje, Power Apps kai rašote kodą, kad prie jo prisijungtumėte.
• Viename darbalapyje naudokite vieną duomenų lentelę.
• Suteikite tą patį pavadinimą DataTable ir darbalapiui.
• "DataTables" naudokite aprašomuosius stulpelių pavadinimus.
• Naudokite Pascal korpusą. Kiekvienas DataTable pavadinimo žodis turi prasidėti didžiąja raide, pvz. EmployeeLeaveRequests

Kintamųjų pavadinimai

Kintamųjų pavadinimų suteikimo taisyklės drobės programose yra svarbios norint išlaikyti projektų skaitomumą, nuoseklumą ir aiškumą Power Apps . Nors griežtas standartas nėra vykdomas, pritaikius nuoseklią pavadinimų suteikimo konvenciją visoje drobės programoje, jums ir kitiems bendradarbiams gali būti lengviau suprasti, naudoti ir valdyti kintamuosius.

• Naudokite kupranugario atvejį, kai kiekvieno žodžio pirmoji raidė yra didžioji, išskyrus pirmąjį žodį.
• Pasirinkite prasmingus ir aprašomuosius pavadinimus, kurie aiškiai apibūdina kintamojo tikslą ar turinį. Venkite pernelyg bendrinių pavadinimų, tokių kaip temp ar var1. Vietoj to naudokite aprašomuosius pavadinimus, pvz., userEmail arba totalAmount.
• Apsvarstykite galimybę naudoti priešdėlius ar priesagas, kad nurodytumėte kintamojo tipą. Pavyzdžiui:
  • strUserName teksto / eilutės kintamajam
  • numTotalAmount skaitiniam kintamajam
  • boolIsEnabled bulio loginiam kintamajam
  • locVarName vietiniams kintamiesiems / konteksto kintamiesiems
  • gblVarLoginUser visuotiniams kintamiesiems
• Nuspręskite, ar jūsų kintamieji turėtų būti pavadinti vienaskaitos ar daugiskaitos forma, ir laikykitės tos konvencijos. Pavyzdžiui, nuosekliai naudokite userCount arba users.
• Venkite naudoti rezervuotus žodžius ar pavadinimus, kurie gali būti nesuderinami su Power Apps funkcijomis ar raktiniais žodžiais. Patikrinkite, Power Apps ar dokumentacijoje nėra rezervuotų žodžių sąrašo.
• Apsvarstykite galimybę naudoti priešdėlius, kurie pateikia kontekstą apie kintamojo naudojimą ar aprėptį. Pavyzdžiui:
  • frm formos kintamiesiems
  • col Kolekcijoms
  • var Bendrosios paskirties kintamiesiems
• Venkite specialiųjų simbolių. Laikykite vardus raidinius ir skaitinius ir venkite specialiųjų simbolių ar tarpų. Laikykitės raidžių ir skaičių.

Power Apps Nustatykime konteksto kintamuosius ir visuotinius kintamuosius tais pačiais pavadinimais. Tai gali sukelti painiavą, nes formulėse pagal numatytuosius nustatymus naudojami konteksto kintamieji, nebent naudojamas maskavimo operatorius .

Išvenkite šios situacijos laikydamiesi šių konvencijų:

• Priešdėlio konteksto kintamieji su. loc
• Priešdėlis visuotiniai kintamieji su gbl.
• Pavadinimas po priešdėlio turėtų nurodyti kintamojo tikslą / tikslą. Galima naudoti kelis žodžius ir jų nereikia atskirti jokiais specialiaisiais simboliais, pvz., tarpais ar pabraukimais, jei kiekvieno žodžio pirmoji raidė rašoma didžiąja raide.
• Naudokite Camel korpusą. Pradėkite kintamųjų pavadinimus priešdėliu mažosiomis raidėmis, tada didžiosiomis raidėmis rašykite kiekvieno vardo žodžio pirmąją raidę.

Šie pavyzdžiai atitinka standartus ir konvencijas:

• Visuotinis kintamasis:gblFocusedBorderColor

• Kontekstinis kintamasis:locSuccessMessage

• Taikymo srities kintamasis:scpRadius

Šie pavyzdžiai neatitinka standartų ir yra sunkiau suprantami:

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

Venkite trumpų ir paslaptingų kintamųjų pavadinimų, tokių kaip EID. Use EmployeeId Vietoj to.

Kai programoje yra daug kintamųjų, galite tiesiog įvesti priešdėlį formulės juostoje, kad pamatytumėte galimų kintamųjų sąrašą. Jei vadovausitės šiomis gairėmis, kad pavadintumėte kintamuosius, kurdami programą juos lengvai rasite formulės juostoje. Galiausiai šis požiūris leidžia greičiau kurti programas.

Rinkinių pavadinimams

• Apibūdinkite kolekcijos turinį. Pagalvokite, kas yra kolekcijoje ir (arba) kaip ji naudojama, tada atitinkamai pavadinkite.
• Kolekcijos turėtų būti priešdėlio su col.
• Pavadinimas po priešdėlio turėtų nurodyti rinkimo tikslą ar tikslą. Galima naudoti kelis žodžius ir jų nereikia atskirti tarpais ar pabraukimais, jei kiekvieno žodžio pirmoji raidė yra didžioji.
• Naudokite Camel korpusą. Pradėkite savo kolekcijos pavadinimus mažosiomis raidėmis priešdėliu, tada didžiosiomis raidėmis rašykite kiekvieno pavadinimo žodžio pirmąją raidę.

Šie pavyzdžiai atitinka rinkinio pavadinimo konvencijas:

• colMenuItems
• colThriveApps

Šie pavyzdžiai neatitinka rinkinio pavadinimo taisyklių:

• orderscoll
• tempCollection

Arbatpinigiai

Kai programoje yra daug kolekcijų, formulės juostoje galite tiesiog įvesti priešdėlį, kad pamatytumėte galimų kolekcijų sąrašą. Kalbant apie kintamuosius, jei vadovausitės šiomis gairėmis kolekcijoms pavadinti, kurdami programą galėsite juos lengvai rasti formulės juostoje. Galiausiai šis požiūris leidžia greičiau kurti programas.

Pastabos ir dokumentai

Kai rašote kodą savo programai, sutelkite dėmesį į aiškių komentarų pridėjimą. Komentarai padeda vėliau suprasti kodą ir palengvina kitam kūrėjui dirbti su projektu.

Power Apps Palaiko du komentarų stilius, kad jūsų kodas būtų aiškesnis: eilutės komentarus, kurie naudoja dvigubus pasviruosius brūkšnius (//) vienos eilutės pastaboms, ir blokuoti komentarus, kurie naudoja /* ir */ kelių eilučių pastabas.

Eilutės komentarai

Pridėkite dvigubą pasvirąjį brūkšnį (//) prie bet kurios kodo eilutės Power Apps , kad likusi eilutės dalis taptų komentaru.

Naudokite eilučių komentarus, kad paaiškintumėte, ką daro kita kodo eilutė. Taip pat galite juos naudoti norėdami laikinai išjungti kodo eilutę testavimui.

Štai eilutės komentaro pavyzdys.

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

Blokuoti komentarus

Tekstas tarp /* ir */ yra blokinis komentaras. Blokuoti komentarus gali apimti kelias eilutes, skirtingai nuo eilučių komentarų, kurie apima tik vieną eilutę.

Naudokite blokuoti komentarus, kad gautumėte ilgesnius paaiškinimus, pvz., dokumentuotumėte kodo modulio antraštę. Taip pat galite juos naudoti norėdami laikinai išjungti kelias kodo eilutes testavimo ar derinimo metu.

Norėdami geriau organizuoti kodą, pridėkite komentarų naudodami funkciją Formatuoti tekstą. Tai padeda, jei jūsų komentarai pateikiami prieš kodo bloką.

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

Teksto formatavimo funkcija komentarams taikoma pagal šias taisykles:

1. Jei ypatybė prasideda bloko komentaru, prie jos pridedama kita kodo eilutė.
2. Jei ypatybė prasideda eilutės komentaru, kita kodo eilutė į ją neįtraukiama. Priešingu atveju kodas komentuojamas.
3. Eilutės ir bloko komentarai kitoje ypatybės vietoje pridedami prie ankstesnės kodo eilutės.

Nesijaudinkite, kad pridėsite per daug ar per ilgų komentarų. Power Apps Pašalina visus komentarus, kai sukuria kliento programos paketą, todėl komentarai neturi įtakos paketo dydžiui ir nesulėtina programos atsisiuntimo ar įkėlimo laiko.

Šiuolaikinis programų dizaineris su komentarais

Geriausia Power Apps naudoti komentavimo funkcijas abiejuose Power Apps Studio ir Šiuolaikinis programų dizaineris.

Norėdami įtraukti komentarų Power Apps Studio, naudokite šiuos metodus:

1. Dešiniuoju pelės mygtuku spustelėkite bet kurio medžio rodinio elemento daugtaškį ("...").
2. Dešiniuoju pelės mygtuku spustelėkite komponentą drobės srityje.
3. Pasirinkite mygtuką "Komentarai", esantį komandų juostoje viršutiniame dešiniajame ekrano kampe.

Kai komentare minite kolegą, naudokite simbolį "@" ir jo vardą. Taip asmeniui, kurį pažymėjote, siunčiamas pranešimo el. laiškas. Jei pažymėtas vartotojas neturi prieigos prie programos, Power Apps paragins jus bendrinti programą su juo.

Įtrauka ir formatavimas

Įtraukimas Power Apps ir formatavimas padeda išlaikyti aiškią ir tvarkingą programą. Laikantis geriausios praktikos formulių ir valdiklių tampa lengviau skaityti.

Formulių juosta

Įtraukimo

Power Apps netaiko griežtos įtraukos, bet galite naudoti tarpus, kad atskirtumėte skirtingas formulių sekcijas. Keletą kartų paspauskite tarpo klavišą, kad sukurtumėte įtrauką.

Eilučių lūžiai

Suskaidykite ilgas formules į kelias eilutes, kad jas būtų lengviau skaityti. Paspauskite Enter, kad formulės juostoje pridėtumėte eilutės lūžį.

Komandos Formatuoti tekstą naudojimas

Formulės juostoje esanti komanda "Formatuoti tekstą" prie kodo prideda įtrauką, tarpus ir eilučių lūžius Power Apps . Naudokite komandą "Formatuoti tekstą", kad išlaikytumėte nuoseklų kodavimo stilių savo drobės programoje ir padėtumėte išvengti klaidų.

Tolesnis veiksmas

Kodo optimizavimas