Споделяне чрез

Четливост на кода

Конвенции за именуване

Общи конвенции за именуване

Този раздел описва конвенциите за именуване на "камилски камили" и "паскал". Ако вече сте запознати с тези термини, можете да пропуснете напред.

Калъф за камила

Трябва да използвате камилски калъф за контроли и променливи. Регистърът Camel започва с малък префикс, премахва всички интервали от имената на обекти или променливи и изписва с главни букви първата буква на всяка дума след първата. Например контролата за въвеждане на текст може да бъде наречена txtUserEmailAddress.

Калъф Паскал

Трябва да използвате Pascal за източници на данни. Случаят на Паскал понякога се нарича "случай на горна камила". Подобно на камилата, той премахва всички интервали и пише с главна буква първата буква на думите. Въпреки това, за разлика от случая с камили, падежът на Паскал също пише първата дума с главна буква. Например общ източник на данни е PowerApps конекторът Microsoft Office 365 Users, който се нарича Office365Users във вашия код.

Екранни имена

Екранните имена трябва да отразяват предназначението на екрана, така че да е по-лесно да навигирате през сложни приложения Power Apps Studio.

Това, което е по-малко очевидно, е, че екранните имена се четат на глас от екранни четци, които са необходими за потребители, които имат нужда от достъпност на зрението. Ето защо е наложително да използвате обикновен език, за да именувате екраните си и имената да включват интервали и да нямат съкращения. Също така ви препоръчваме да завършите името с думата "Екран", така че контекстът да бъде разбран, когато името е обявено.

Ето няколко добри примера:

  • Home_Screen или Home Screen
  • Search_Screen или Search Screen

Екранна снимка, която показва списък с екранни имена, които следват описания модел

Тези примерни екранни имена са по-малко разбираеми:

  • Home
  • LoaderScreen
  • EmpProfDetails
  • Thrive Help

Имена на контроли

Всички имена на контроли на платното трябва да използват камилски калъф. Те трябва да започнат с дескриптор от три знака, последван от целта на контрола. Този подход помага да се идентифицира вида на контрола и улеснява изграждането на формули и търсенето. Например, lblUserName показва, че контролата е етикет.

Таблицата по-долу показва съкращенията за общи контроли.

Контролно име Съкращение
Значка БДГ
Button btn
Управление на камерата Камера
Платно мога
Card Дки
Диаграми CHR
Квадратче за отметка chk
Колекция Полковник
Combo box CMB
Компонент CMP
Контейнер против
Дати DTE
Падащ списък Drp
Формуляр FRM
Галерия Гал
Групов GRP
Заглавен ред HDR
Html текст htm
Icon ICO
Image img
Бутон за информация информация
Label lbl
Свържи lnk
List box lst
Микрофон Микрофон
Microsoft Stream ул
Форма на секция на страницата сек
Въвеждане с писалка писалка
Плочка на Power BI ПБИ
Лента за напредък pbar
Rating RTG
Rich text editor RTE
Фигури (правоъгълник, кръг и т.н.) SHP
Плъзгач sld
Списък с раздели tbl
Table tbl
Text input txt
Таймер tmr
Toggle TGL
Видео видео

Подробен списък на контролите и техните свойства са описани в справочника Контроли.

Бележка

Имената на контролите трябва да са уникални в приложението. Ако дадена контрола се използва повторно на няколко екрана, краткото име на екрана трябва да има наставка. Например, galBottomNavMenuHS където "HS" означава "Начален екран". Този подход улеснява препращането към контролата във формули на различни екрани.

Ето няколко лоши примера:

  • zipcode
  • Next

Когато постоянно наименувате контролите си, приложението ви е по-чисто в изгледа за навигация, а кодът ви също е по-чист.

Екранна снимка на навигационния изглед, показващ имената на контролите, следващи шаблона

Имена на източници на данни

Когато добавите източник на данни към вашето приложение, името не може да бъде променено в Power Apps приложението. Името се наследява от конектора източник или обектите на данни, които са извлечени от връзката.

Ето някои примери:

  • Име, наследено от конектора източник: Конекторът Office 365 за потребители се нарича Office365Users във вашия код.
  • Обекти на данни, получени от връзката: Списък на Microsoft SharePoint Employees се връща от конектора SharePoint . Следователно името на източника на данни във вашия код е Служители. Едно и също Power Apps приложение може да използва същия SharePoint конектор за достъп до SharePoint списък с Contractors име. В този случай името на източника на данни в кода е Contractors.

За повече информация относно конекторите и връзките вижте Общ преглед на конекторите за приложения за платно за Power Apps.

Стандартни конектори за действие

В стандартните конектори за действия, които показват функции, като LinkedIn, името на източника на данни и неговите операции използват Pascal регистър. Например източникът на данни на LinkedIn се нарича LinkedIn и има операция с име. ListCompanies

ClearCollect(
    colCompanies,
    LinkedIn.ListCompanies()
)

Персонализирани конектори

Персонализирани конектори, използвани за свързване към персонализирани приложно-програмни интерфейси (API), като например услуги или бизнес API, създадени от вашата фирма. Те могат да бъдат създадени от всеки производител във вашата среда. Препоръчваме Pascal корпус за името на източника на данни и неговите операции. Само имайте предвид, че името на персонализирания конектор и начинът, по който се показва PowerApps , могат да се различават.

Помислете за този пример за персонализиран конектор с MS Auction Item Bid API име.

Екранна снимка на конектор с име MS Auction Item Bid API

Но когато създадете връзка от този конектор и го добавите към приложението си PowerApps като източник на данни, той изглежда като AuctionItemBidAPI.

Екранна снимка на конектор, показващ, че името е AuctionItemBidAPI

За да откриете причината, можете да потърсите вътре във OpenAPI файла атрибут title, който съдържа текста Auction Item Bid API.

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

Power Apps премахва всички интервали от тази стойност на атрибута и я използва като име на вашия източник на данни.

Съвет

Препоръчваме ви да промените стойността на този атрибут на име с малки и малки букви на Pascal, като например AuctionItemBidAPI и да го използвате като име на вашата персонализирана връзка. По този начин няма да има объркване. Променете тази стойност, преди да импортирате файла, OpenAPI за да създадете конектора по избор.

Бележка

Ако използвате опцията Създаване от празен файл, вместо да импортирате съществуващ OpenAPI файл, PowerApps ще ви подкани името на конектора по избор. Това име ще се използва както като име на персонализирания конектор, така и като стойност на атрибута title във OpenAPI файла. Не забравяйте да използвате име AuctionItemBidAPI с паскал, за да поддържате нещата последователни и прости.

Таблици с данни на Excel

PowerApps използва DataTables in Microsoft Excel , за да се свърже с данни в работни листове на Excel. Имайте предвид тези точки, когато създавате документи на Excel като източници на данни:

  • Дайте на вашите таблици с данни описателни имена. Името е в Power Apps приложението, когато пишете кода, за да се свържете с него.
  • Използвайте една таблица с данни на работен лист.
  • Дайте същото име на таблицата с данни и работния лист.
  • Използвайте описателни имена на колони в таблиците с данни.
  • Използвайте корпус Pascal. Всяка дума от името на DataTable трябва да започва с главна буква, като например EmployeeLeaveRequests.

Имена на променливи

Конвенциите за именуване на променливи в приложенията за платно са важни за поддържане на четливост, последователност и яснота във вашите Power Apps проекти. Въпреки че не се прилага строг стандарт, приемането на последователна конвенция за именуване във вашето приложение за платно може да улесни вас и другите сътрудници да разбирате, използвате и управлявате променливите.

  • Използвайте камилски регистър, където първата буква на всяка дума е с главна буква, с изключение на първата дума.
  • Изберете смислени и описателни имена, които ясно описват целта или съдържанието на променливата. Избягвайте прекалено общи имена като temp или var1. Вместо това използвайте описателни имена като userEmail или totalAmount.
  • Помислете за използване на префикси или суфикси, за да посочите типа на променливата. Например:
    • strUserName за променлива текст/низ
    • numTotalAmount за числова променлива
    • boolIsEnabled за булева променлива
    • locVarName за локални променливи/контекстни променливи
    • gblVarLoginUser за глобални променливи
  • Решете дали вашите променливи трябва да бъдат именувани в единствено или множествено число и се придържайте към тази конвенция. Например последователно използвайте userCount или users.
  • Избягвайте използването на запазени думи или имена, които може да са в конфликт с Power Apps функции или ключови думи. Проверете Power Apps документацията за списък със запазени думи.
  • Помислете за използване на префикси, които предоставят контекст за използването или обхвата на променливата. Например:
    • frm за променливи на формуляри
    • col за колекции
    • var за променливи с общо предназначение
  • Избягвайте специални знаци. Запазете имената буквено-цифрови и избягвайте специални знаци или интервали. Придържайте се към буквите и цифрите.

Power Apps Нека контекстните променливи и глобалните променливи споделят едни и същи имена. Това може да доведе до объркване, тъй като вашите формули използват контекстни променливи по подразбиране, освен ако не се използва операторът за отстраняване на неясноти.

Избягвайте тази ситуация, като следвате тези конвенции:

  • Префикс контекстни променливи с loc.
  • Префикс глобални променливи с gbl.
  • Името след префикса трябва да показва намерението/целта на променливата. Могат да се използват няколко думи и не е необходимо да се разделят със специални знаци, като интервали или долни черти, ако първата буква на всяка дума е с главна буква.
  • Използвайте корпус Camel. Започнете имената на променливите си с префикс с малки букви и след това изпишете с главна буква първата буква на всяка дума в името.

Тези примери следват стандартите и конвенциите:

  • Глобална променлива:gblFocusedBorderColor

  • Контекстна променлива:locSuccessMessage

  • Променлива на обхвата:scpRadius

Тези примери не следват стандартите и са по-трудни за разбиране:

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

Избягвайте кратки и загадъчни имена на променливи, като например EID. Use EmployeeId Вместо.

Когато в дадено приложение има много променливи, можете просто да въведете префикса в лентата с формули, за да видите списък с наличните променливи. Ако следвате тези указания за именуване на променливите си, можете лесно да ги намерите в лентата с формули, докато разработвате приложението си. В крайна сметка този подход води до по-бърза разработка на приложения.

Имена на колекции

  • Бъдете описателни за съдържанието на колекцията. Помислете какво съдържа колекцията и/или как се използва и след това я наименувайте съответно.
  • Колекциите трябва да бъдат с префикс. col
  • Името след префикса трябва да показва намерението или целта на колекцията. Могат да се използват няколко думи и не е необходимо да се разделят с интервали или долни черти, ако първата буква на всяка дума е с главна буква.
  • Използвайте корпус Camel. Започнете имената на колекцията си с префикс с малки букви и след това изпишете с главна буква на всяка дума в името.

Тези примери следват конвенциите за имена на колекция:

  • colMenuItems
  • colThriveApps

Тези примери не следват конвенциите за имената на колекцията:

  • orderscoll
  • tempCollection

Съвет

Когато има много колекции в приложението, можете просто да въведете префикса в лентата с формули, за да видите списък с наличните колекции. Що се отнася до променливите, ако следвате тези указания, за да именувате колекциите си, ще можете лесно да ги намерите в лентата с формули, докато разработвате приложението си. В крайна сметка този подход води до по-бърза разработка на приложения.

Коментари и документация

Когато пишете код за вашето приложение, съсредоточете се върху добавянето на ясни коментари. Коментарите ви помагат да разберете кода си по-късно и улесняват следващия разработчик да работи по проекта.

Power Apps Поддържа два стила на коментари, за да направи кода ви по-ясен: редови коментари, които използват двойни наклонени черти (//) за едноредови бележки, и блокови коментари, които използват /* и */ за многоредови бележки.

Редови коментари

Добавете двойна наклонена черта (//) към който и да е ред код, Power Apps за да направите останалата част от реда коментар.

Използвайте редови коментари, за да обясните какво прави следващият ред код. Можете също да ги използвате, за да деактивирате временно ред код за тестване.

Ето пример за коментар на ред.

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

Блокиране на коментари

Текст между /* и */ е блокиращ коментар. Блоковите коментари могат да обхващат няколко реда, за разлика от редовите коментари, които обхващат само един ред.

Използвайте блокови коментари за по-дълги обяснения, като например документиране на заглавка на кодов модул. Можете също да ги използвате, за да деактивирате временно няколко реда код по време на тестване или отстраняване на грешки.

За по-добра организация на кода добавете коментари, след като използвате функцията за форматиране на текст. Това помага, ако коментарите ви идват преди блокиране на код.

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

Функцията за форматиране на текст следва следните правила за коментари:

  1. Ако дадено свойство започва с коментар на блок, към него се добавя следващият ред код.
  2. Ако дадено свойство започва с коментар на ред, следващият ред код не се добавя към него. В противен случай кодът се коментира.
  3. Редовите и блоковите коментари на други места в свойството се добавят към предишния ред код.

Не се притеснявайте, че ще добавите твърде много или твърде дълги коментари. Power Apps Премахва всички коментари, когато създава пакета на клиентското приложение, така че коментарите не влияят на размера на пакета или забавят изтеглянията на приложението или времето за зареждане.

Модерен дизайнер на приложения с коментари

Най-добре Power Apps е да използвате функциите за коментиране както Power Apps Studio в Modern App Designer, така и в Modern App Designer.

За да добавите коментари Power Apps Studio, използвайте следните методи:

  1. Щракнете с десния бутон върху многоточието ("...") на който и да е елемент в дървовидния изглед.
  2. Щракнете с десния бутон върху компонент в областта на платното.
  3. Изберете бутона "Коментари", разположен в командната лента в горния десен ъгъл на екрана.

Когато споменавате колега в коментар, използвайте символа "@", последван от името му. Това изпраща имейл с известие до човека, когото маркирате. Ако маркираният потребител няма достъп до приложението, Power Apps ви подканва да споделите приложението с него.

Екранна снимка на приложение за разходи, показващо човек, споменат с @ в коментар.

Отстъп и форматиране

Вдлъбнатината Power Apps, отстъпите и форматирането помагат за поддържането на приложението ви ясно и организирано. Следването на най-добрите практики прави вашите формули и контроли по-лесни за четене.

Лента за формули

Отстъп

Power Apps не налага строг отстъп, но можете да използвате интервали, за да разделите различните секции от формулите си. Натиснете интервала няколко пъти, за да създадете вдлъбнатина.

Прекъсвания на редовете

Разбийте дългите формули на няколко реда, за да ги направите по-лесни за четене. Натиснете Enter, за да добавите нов ред в лентата за формули.

Използване на командата Форматиране на текст

Командата "Форматиране на текст" в лентата за формули добавя отстъп, разстояние и нови редове към вашия Power Apps код. Използвайте командата "Форматиране на текст", за да поддържате последователен стил на кодиране във вашето приложение за платно и да предотвратите грешки.

Екранна снимка на Power Apps Studio с маркираната команда Форматиране на текст.

Следваща стъпка

Оптимизация на кода