Jagamisviis:

Koodi loetavus

Nimetamise reeglid

Üldised nimetamisreeglid

Selles jaotises kirjeldatakse "kaameli juhtumi" ja "Pascali juhtumi" nimetamistavande. Kui olete nende terminitega juba tuttav, võite edasi liikuda.

Kaameli juhtum

Kontrollide ja muutujate jaoks peaksite kasutama kaameli ümbrist. Kaameli suurtäht algab väiketähtede eesliitega, eemaldab objektide või muutujate nimedest kõik tühikud ja kirjutab iga sõna esimese tähe pärast esimest suurtähte. Näiteks võib tekstisisestuse juhtelemendi nimi olla txtUserEmailAddress.

Pascali juhtum

Andmeallikate jaoks peaksite kasutama Pascali juhtumit. Pascali juhtumit nimetatakse mõnikord "ülemiseks kaameli juhtumiks". Nagu kaameli ümbris, eemaldab see kõik tühikud ja kirjutab sõnade esimese tähe suurtähtedega. Kuid erinevalt kaameli juhtumist kirjutab Pascali kääne ka esimese sõna suure algustähega. Näiteks on tavaline andmeallikas PowerApps konnektor Kasutajad Microsoft Office 365 , mille nimi on teie koodis Office365Kasutajad.

Ekraaninimed

Ekraaninimed peaksid kajastama ekraani eesmärki, et keerulistes rakendustes oleks lihtsam navigeerida Power Apps Studio.

Vähem ilmne on see, et ekraanilugejad loevad ekraaninimed ette, mida on vaja kasutajatele, kellel on nägemise juurdepääsetavuse vajadus. Seetõttu on hädavajalik, et kasutaksite oma ekraanide nimetamiseks lihtsat keelt ja et nimed sisaldaksid tühikuid ja mitte lühendeid. Samuti soovitame teil nime lõpetada sõnaga "Ekraan", et nime väljakuulutamisel oleks kontekst arusaadav.

Siin on mõned head näited:

  • Home_Screen või Home Screen
  • Search_Screen või Search Screen

Kuvatõmmis, kus on kuvatud kuvatud kuvanimede loend, mis järgib kirjeldatud mustrit

Need ekraaninimede näited on vähem arusaadavad:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Juhtelementide nimed

Kõik lõuendil olevad kontrollnimed peaksid kasutama kaameli ümbrist. Need peaksid algama kolmetähemärgilise tüübikirjeldusega, millele järgneb kontrolli eesmärk. See lähenemine aitab tuvastada juhtelemendi tüüpi ning hõlbustab valemite koostamist ja otsingut. Näiteks näitab, lblUserName et juhtelement on silt.

Järgmises tabelis on toodud tavaliste juhtelementide lühendid.

Juhtelemendi nimi Lühend
Märk BDG
Button btn
Kaamera juhtimine Cam
Canvas Võib
Card Crd
Diagrammid Chr
Märkeruut CHK
Kogum Col
Liitboks CMB
Komponent CMP
Ümbris Con
Kuupäevad dte
Rippmenüü drp
Vorm FRM
Galerii Gal
Grupp grp
Päis Hdr
HTML-tekst htm
Icon ICO
Image img
Nupp Info teave
Label lbl
Linkimine lnk
Loendiväli lst
Mikrofon mikrofon
Microsoft Stream Str
Lehejaotise kuju sek
Pliiatsi sisestamine sulepea
Power BI paan PBI
Edenemisriba PBAR
Rating Rtg
RTF-redaktor Rte
Kujundid (ristkülik, ring jne) shp
Liugur sld
Vahekaartide loend TBL
Table TBL
Tekstisisestus txt
Ajasti TMR
Toggle TGL
Video vid

Juhtelementide ja nende atribuutide üksikasjalikku loendit kirjeldatakse jaotises Juhtelementide viide.

Märkus.

Juhtelementide nimed peavad olema kogu rakenduses kordumatud. Kui juhtelementi kasutatakse uuesti mitmel ekraanil, peaks lühikesel ekraaninimel olema järelliide. Näiteks galBottomNavMenuHS kus "HS" tähendab "avakuva". See lähenemine hõlbustab juhtelemendile viitamist valemites ekraanidel.

Siin on mõned halvad näited:

  • zipcode
  • Next

Kui nimetate juhtelemente järjepidevalt, on teie rakendus navigeerimisvaates puhtam ja ka kood puhtam.

Kuvatõmmis navigeerimisvaatest, millel on kujutatud mustri järgi juhtelementide nimed

Andmeallikate nimed

Kui lisate oma rakendusele andmeallika, ei saa seda nime rakenduses Power Apps muuta. Nimi päritakse lähtekonnektorilt või andmeüksustelt, mis on tuletatud ühendusest.

Järgmiselt on toodud mõned näited.

  • Lähtekonnektorilt päritud nimi: Kasutajate Office 365 konnektori nimi on teie koodisOffice365Kasutajad.
  • Ühendusest tuletatud andmeüksused: Konnektorist tagastatakse SharePoint Microsofti Employees loend nimega SharePoint . Seetõttu on teie koodis andmeallika nimi Töötajad. Sama Power Apps rakendus saab kasutada sama SharePoint konnektorit ka nimega SharePoint loendile juurdepääsuks Contractors. Sel juhul on Contractors koodis oleva andmeallika nimi.

Lisateavet konnektorite ja ühenduste kohta leiate teemast Lõuendirakenduse konnektorite Power Apps ülevaade.

Standardsed toimingu konnektorid

Standardtoimingukonnektorites, mis paljastavad funktsioone (nt LinkedIn), kasutavad andmeallika nimi ja selle toimingud Pascali korpust. Näiteks LinkedIni andmeallika nimi on LinkedIn ja sellel on toiming nimega ListCompanies.

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Kohandatud konnektorid

Kohandatud konnektorid, mida kasutatakse ühenduse loomiseks kohandatud rakendusliidestega (API-d), nagu teenused või ärivaldkonna API-d, mille teie ettevõte on loonud. Neid saab luua iga teie keskkonna tegija. Soovitame andmeallika nime ja selle toimingute jaoks kasutada Pascali korpust. Pidage meeles, et kohandatud konnektori nimi ja selle kuvamisviis PowerApps võivad erineda.

Mõelge sellele kohandatud konnektori MS Auction Item Bid API näitele.

Kuvatõmmis konnektorist nimega MS Auction Item Bid API

Kuid kui loote sellest konnektorist ühenduse ja lisate selle oma PowerApps rakendusse andmeallikana, kuvatakse see järgmiselt AuctionItemBidAPI.

Kuvatõmmis konnektorist, mis näitab, et nimi on AuctionItemBidAPI

Põhjuse väljaselgitamiseks võite otsida OpenAPI failist teksti sisaldavat pealkirja atribuuti Auction Item Bid API.

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

Power Apps eemaldab sellest atribuudi väärtusest kõik tühikud ja kasutab seda oma andmeallika nimena.

Jootraha

Soovitame muuta selle atribuudi väärtuse Pascali juhtumitega nimeks, näiteks AuctionItemBidAPI ja kasutada seda kohandatud ühenduse nimena. Nii ei teki segadust. Muutke seda väärtust enne faili importimist OpenAPI kohandatud konnektori loomiseks.

Märkus.

Kui kasutate olemasoleva faili importimise asemel suvandit Loo tühjast OpenAPI , PowerApps küsitakse teilt kohandatud konnektori nime. Seda nime kasutatakse nii kohandatud konnektori nimena kui ka failis oleva OpenAPI pealkirja atribuudi väärtusena. Kasutage kindlasti Pascali ümbrisega nime, et AuctionItemBidAPI asjad oleksid järjepidevad ja lihtsad.

Exceli andmetabelid

PowerApps kasutab Exceli töölehtedel andmetega ühenduse loomiseks DataTables Microsoft Excel . Exceli dokumentide andmeallikatena loomisel pidage meeles järgmisi punkte.

  • Andke oma andmetabelitele kirjeldavad nimed. Nimi on rakenduses Power Apps , kui kirjutate sellega ühenduse loomiseks koodi.
  • Kasutage ühte andmetabelit töölehe kohta.
  • Andke andmetabelile ja töölehele sama nimi.
  • Kasutage andmetabelites kirjeldavaid veerunimesid.
  • Kasutage Pascali korpust. DataTable’i nime iga sõna peaks algama suure tähega, näiteks EmployeeLeaveRequests.

Muutujate nimed

Lõuendirakenduste muutujate nimetamisreeglid on olulised projektide Power Apps loetavuse, järjepidevuse ja selguse säilitamiseks. Kuigi rangeid standardeid ei rakendata, võib ühtse nimetamiskonventsiooni kasutuselevõtt kogu lõuendirakenduses hõlbustada muutujate mõistmist, kasutamist ja haldamist nii teil kui ka teistel kaastöötajatel.

  • Kasutage kaameli suurtähte, kus iga sõna esimene täht on suurtähtedega, välja arvatud esimene sõna.
  • Valige tähendusrikkad ja kirjeldavad nimed, mis kirjeldavad selgelt muutuja eesmärki või sisu. Vältige liiga üldisi nimesid, nagu temp või var1. Selle asemel kasutage kirjeldavaid nimesid, nagu userEmail või totalAmount.
  • Kaaluge muutuja tüübi tähistamiseks ees- või järelliidete kasutamist. Näiteks:
    • strUserName Muutuja Text/String jaoks
    • numTotalAmount numbrilise muutuja jaoks
    • boolIsEnabled kahendmuutuja jaoks
    • locVarName Kohalike muutujate/kontekstimuutujate jaoks
    • gblVarLoginUser globaalsete muutujate puhul
  • Otsustage, kas teie muutujaid tuleks nimetada ainsuses või mitmuses, ja pidage sellest konventsioonist kinni. Näiteks kasutage järjepidevalt userCount või users.
  • Vältige reserveeritud sõnade või nimede kasutamist, mis võivad olla vastuolus funktsioonide või märksõnadega Power Apps . Reserveeritud sõnade loendi leiate dokumentatsioonist Power Apps .
  • Kaaluge eesliidete kasutamist, mis annavad konteksti muutuja kasutamise või ulatuse kohta. Näiteks:
    • frm vormimuutujate jaoks
    • col Kollektsioonide jaoks
    • var üldotstarbeliste muutujate puhul
  • Vältige erimärke. Hoidke nimed tähtnumbrilised ja vältige erimärke või tühikuid. Pidage kinni tähtedest ja numbritest.

Power Apps Vaatame kontekstimuutujatel ja globaalsetel muutujatel on samad nimed. See võib tekitada segadust, kuna teie valemid kasutavad vaikimisi kontekstimuutujaid, välja arvatud juhul, kui kasutatakse täpsustusmärke.

Vältige seda olukorda, järgides järgmisi tavasid:

  • Kontekstimuutujate eesliide abil loc.
  • Globaalsete gbl muutujate eesliide.
  • Eesliite järel olev nimi peaks näitama muutuja kavatsust/eesmärki. Kasutada saab mitut sõna ja neid ei pea eraldama erimärkidega (nt tühikud või allkriipsud), kui iga sõna esimene täht on suurtähtedega.
  • Kasutage kaameli korpust. Alustage muutujate nimesid väiketähtedega eesliitega ja seejärel kirjutage nime iga sõna esimene täht suurtähtedega.

Need näited järgivad standardeid ja tavasid:

  • Globaalne muutuja:gblFocusedBorderColor

  • Konteksti muutuja:locSuccessMessage

  • Ulatuse muutuja:scpRadius

Need näited ei järgi standardeid ja neid on raskem mõista:

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

Vältige lühikesi ja krüptilisi muutujate nimesid, näiteks EID. Use EmployeeId Selle asemel.

Kui rakenduses on palju muutujaid, saate saadaolevate muutujate loendi kuvamiseks lihtsalt tippida eesliite valemiribale. Kui järgite muutujate nimetamiseks neid juhiseid, leiate need rakenduse arendamise ajal hõlpsalt valemiribalt. Lõppkokkuvõttes viib see lähenemine rakenduste kiirema arendamiseni.

Kogumite nimed

  • Kirjeldage kogu sisu. Mõelge, mida kollektsioon sisaldab ja/või kuidas seda kasutatakse, ning seejärel nimetage see vastavalt.
  • Kollektsioonide ees peaks olema eesliide col.
  • Eesliite järel olev nimi peaks näitama kollektsiooni eesmärki või eesmärki. Kasutada saab mitut sõna ja neid ei pea eraldama tühikute või allkriipsuga, kui iga sõna esimene täht on suurtähtedega.
  • Kasutage kaameli korpust. Alustage oma kollektsiooni nimesid väikese veeru eesliitega ja seejärel kirjutage nime iga sõna esimene täht suure algustähega.

Need näited järgivad kogumi nimekonventsioone.

  • colMenuItems
  • colThriveApps

Need näited ei järgi kollektsiooni nimekonventsioone.

  • orderscoll
  • tempCollection

Jootraha

Kui rakenduses on palju kollektsioone, saate saadaolevate kollektsioonide loendi nägemiseks lihtsalt sisestada eesliite valemiribale. Mis puutub muutujatesse, siis kui järgite neid juhiseid oma kollektsioonide nimetamiseks, leiate need rakenduse arendamise ajal hõlpsalt valemiribalt. Lõppkokkuvõttes viib see lähenemine rakenduste kiirema arendamiseni.

Kommentaarid ja dokumentatsioon

Kui kirjutate oma rakenduse jaoks koodi, keskenduge selgete kommentaaride lisamisele. Kommentaarid aitavad teil hiljem oma koodist aru saada ja hõlbustavad järgmisel arendajal projektiga töötamist.

Power Apps Koodi selgemaks muutmiseks toetab kahte kommentaarilaadi: reakommentaarid, mis kasutavad üherealiste märkmete jaoks topeltkaldkriipse (//), ja blokeeritud kommentaarid, mis kasutavad /* ja */ mitmerealiste märkmete jaoks.

Rea kommentaarid

Lisage kahekordne kaldkriips (//) mis tahes koodireale Power Apps , et muuta ülejäänud rida kommentaariks.

Kasutage reakommentaare, et selgitada, mida järgmine koodirida teeb. Neid saate kasutada ka koodirea ajutiseks keelamiseks testimiseks.

Siin on näide rea kommentaarist.

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

Kommentaaride blokeerimine

Tekst ja vahel /**/ on plokkkommentaar. Plokikommentaarid võivad hõlmata mitut rida, erinevalt reakommentaaridest, mis hõlmavad ainult ühte rida.

Kasutage plokkkommentaare pikemate selgituste jaoks, näiteks koodimooduli päise dokumenteerimiseks. Saate neid kasutada ka mitme koodirea ajutiseks keelamiseks testimise või silumise ajal.

Koodi paremaks korraldamiseks lisage kommentaare pärast teksti vormindamise funktsiooni kasutamist. See aitab, kui teie kommentaarid tulevad enne koodiplokki.

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

Teksti vormindamise funktsioon järgib kommentaaride puhul järgmisi reegleid.

  1. Kui atribuut algab ploki kommentaariga, lisatakse sellele järgmine koodirida.
  2. Kui atribuut algab reakommentaariga, siis järgmist koodirida sellele ei lisata. Vastasel juhul kommenteeritakse kood välja.
  3. Rea- ja plokikommentaarid mujal atribuudis lisatakse eelmisele koodireale.

Ärge muretsege liiga paljude või liiga pikkade kommentaaride lisamise pärast. Power Apps Eemaldab klientrakenduse paketi loomisel kõik kommentaarid, nii et kommentaarid ei mõjuta paketi suurust ega aeglusta rakenduse allalaadimist ega laadimisaega.

Kaasaegne rakenduse kujundaja koos kommentaaridega

Sisse Power Apps on kõige parem kasutada kommenteerimisfunktsioone mõlemas Power Apps Studio ja Kaasaegne rakenduse kujundaja.

Kommentaaride Power Apps Studio lisamiseks kasutage järgmisi meetodeid.

  1. Paremklõpsake puuvaates mis tahes üksuse kolmikpunkti ("...").
  2. Paremklõpsake lõuendi alal olevat komponenti.
  3. Valige nupp "Kommentaarid", mis asub ekraani paremas ülanurgas käsuribal.

Kui mainite kommentaaris kolleegi, kasutage sümbolit "@", millele järgneb tema nimi. See saadab märgeldavale inimesele teavitusmeili. Kui sildistatud kasutajal pole rakendusele juurdepääsu, Power Apps palub teil rakendust temaga jagada.

Kuvatõmmis kulurakendusest, millel on kommentaaris @-ga mainitud inimene.

Taane ja vormindamine

Sisse, Power Apps taane ja vormindamine aitavad hoida teie rakenduse selge ja organiseerituna. Heade tavade järgimine muudab valemid ja juhtelemendid hõlpsamini loetavaks.

Valemiriba

Taane

Power Apps ei jõusta ranget taanet, kuid valemite erinevate jaotiste eraldamiseks saate kasutada tühikuid. Vajutage taande loomiseks mitu korda tühikuklahvi.

Reapiirid

Jagage pikad valemid mitmeks reale, et neid oleks lihtsam lugeda. Vajutage sisestusklahvi (Enter), et lisada valemiribale reapiir.

Käsu Vorminda teksti kasutamine

Valemiriba käsk "Vorminda teksti" lisab teie Power Apps koodile taande, vahed ja reapiirid. Kasutage käsku "Vorminda teksti", et säilitada lõuendirakenduses ühtne kodeerimisstiil ja aidata vältida vigu.

Kuvatõmmis, Power Apps Studio kus on esile tõstetud käsk Vorminda teksti.

Järgmine etapp

Koodi optimeerimine

  • Last updated on