1C: Podnik 8.2 /
Pre vývojárov /
Dohovory o kóde

Obsah

1.1. Vo všeobecnom prípade môžu byť v programovom module (všeobecné moduly, moduly objektov, moduly správcov objektov, moduly formulárov, príkazy atď.) Nasledujúce oddiely: sekvencie :

Niektoré sekcie môžu byť prítomné iba v moduloch určitého typu. Obslužné programy udalostí pre elementy formulára môžu byť napríklad prítomné iba vo moduloch formulára a sekcia opisu premennej a inicializačná sekcia sa nedajú definovať v neglobálnych všeobecných moduloch, moduloch správcu objektov, množinách záznamov, konštantných hodnotách a moduloch relácií.

Účelom požiadavky rozdeliť kód modulu na oddiely je zvýšiť čitateľnosť kódu a zjednodušiť zavádzanie zmien kódu rôznymi autormi ( vývojári ) ako v kolektívnom vývoji a pri zdokonalení aplikačných riešení pre konkrétne implementácie.

1.2. Časti šablón (prázdne pre kopírovanie) pre bežné moduly:

////////////////////////////////////////////////// / / / / / / / / /// / / / / / / / / / / // // // / / / / / / / / / / ////////////////////////////////////////////////// / / / / / / / / / / / / / / / / ////////////////////////////// ///////////////////////////////////// // // // // ROZHRANIE SOFTVÉRU // ////////////////////////////////////////////////// /////////////////////// // // SERVISNÉ POSTUPY A FUNKCIE

• Oddiel „Programové rozhranie“ obsahuje exportné procedúry a funkcie určené na použitie inými konfiguračnými objektmi alebo inými programami (napríklad prostredníctvom externého pripojenia).
• Sekcia „Utility Utility and Functions“ obsahuje procedúry a funkcie, ktoré tvoria internú implementáciu spoločného modulu. V prípadoch, keď spoločný modul je súčasťou niektorých funkčné V prípade subsystémov, ktoré obsahujú niekoľko objektov metaúdajov, môže táto časť obsahovať aj postupy a funkcie na export služieb, ktoré sa majú volať iba z iných objektov tohto subsystému.
  V prípade hromadných bežných modulov sa odporúča rozdeliť túto časť do podsekcií podľa funkčného atribútu. Pododdielom predchádza komentár, ktorý sa odporúča vydať podobným spôsobom. Napríklad:

////////////////////////////////////////////////// ////////////////////////// // Aktualizácia informačnej základne

1.3. Šablóna na navrhovanie oddielov pre objektové moduly, manažérov, sady záznamov, úpravy, správy atď.

////////////////////////////////////////////////// /////////////////////////// // // ROZHRANIE SOFTVÉRU ////////// // ////////////////////////////////////////////////// //////////// // PROCESORI AKCIÍ //////////////////////////// ///////////////////////////////////////// // // // // POSTUPY A FUNKCIE SLUŽBY

• Oddiel „Programové rozhranie“ obsahuje exportné postupy a funkcie určené na použitie v iných konfiguračných moduloch alebo iných programoch (napríklad prostredníctvom externého pripojenia). V tejto časti nie je potrebné umiestňovať exportné funkcie a postupy, ktoré sa majú volať výlučne z modulov samotného objektu, jeho foriem a príkazov. Napríklad procedúry na vyplnenie časti tabuľky dokumentu, ktoré sa volajú zo spracovania výplne v objektovom module a z formulára dokumentu v obslužnom nástroji príkazov formulára, nie sú programovým rozhraním objektového modulu, pretože sa volajú iba v samotnom module az foriem toho istého objektu. Mali by byť umiestnené v časti Msgstr "Postupy a funkcie pomocného programu."
• Sekcia „ Spracovatelia udalostí“ obsahuje ovládače udalostí pre modul objektu ( Prizavisi , PRO atď.)
• Časť "Postupy a funkcie pomocného programu" má rovnaký účel ako vo všeobecných moduloch.

1.4. Šablóna návrhu oddielu pre moduly formulára:

////////////////////////////////////////////////// /////////////////////////// // MANIPULÁCIA S UDALOSTI FORMULÁR ///////////// ////////////////////////////////////////////////// ///////////// // MANIPULÁTORY UDALOSTÍ PRVKOV TvarU FORMU ////////////////////// ////////////////////////////////////////////////// // // PROCESORI UDALOSTÍ FORMULÁR TABUĽKY //////////////////////////////////// /////////////////////////////// // // PROCESORI PRE TÍMOVO FORMU /////// ////////////////////////////////////////////////// ///////////////////// // // SERVISNÉ POSTUPY A FUNKCIE

• Časť „Obslužné programy udalostí formulára“ obsahuje postupy obsluhy udalostí formulára: Pri vytvorení servera , otvorení atď.
• Oddiel "Ovládače prvkov formulára" obsahuje postupy na spracovanie prvkov nachádzajúcich sa v hlavnej časti formulára (všetko, čo nesúvisí s tabuľkami vo formulári).
• V sekciách „Obslužné programy udalostí tabuľky s tabuľkami <názov tabuľky formulárov>“ sú postupy pre obsluhy prvkov tabuľky formulárov a tabulkových prvkov. Pri postupoch obsluhy musí mať každá tabuľka svoj vlastný oddiel.
• Oddiel „Obslužné programy príkazov formulára“ obsahuje postupy pre obslužné programy príkazov formulára (ktorých názvy sú špecifikované vo vlastnostiach Akcie príkazov formulára).
• Časť "Postupy a funkcie pomocného programu" má rovnaký účel ako vo všeobecných moduloch.

Pozri tiež: Pravidlá pre vytváranie modulov formulárov

2. Všeobecné požiadavky na časti softvérových modulov.

2.1. Hlavička modulu je komentárom na úplnom začiatku modulu. Hlavička modulu poskytuje stručný popis a podmienky aplikácie.
Napríklad:

////////////////////////////////////////////////// ////////////////////// // // Klientske postupy a funkcie všeobecného účelu: // - na prácu so zoznamami vo formulároch; // - pracovať s denníkom; // - pre činnosti spracovania užívateľ prebieha editovať // multiline text napríklad poznámky v dokumentoch; // - iné. // //////////////////////////////////////////// ////////////////////////////////

Pre moduly formulára sa odporúča umiestniť popis parametrov formulára do hlavičky.

2.2. Popis premennej . Názvy premenných sa prideľujú podľa všeobecného názvu pravidlá premenného názvu a ich použitie je opísané v článku. Použitie globálnych premenných v softvérových moduloch ,

Všetky premenné modulov by mali mať komentár postačujúci na pochopenie ich účelu. Komentár sa odporúča umiestniť do toho istého riadku, v ktorom je premenná deklarovaná.
príklad:

Pem menaÚčet export; // Mena, v ktorej je vedené účtovníctvo Perem Address Support Export; // E-mailová adresa, na ktorú sa odosielajú chybové správy

2.3. Softvérové ​​rozhranie Exportné procedúry a funkcie, ktoré tvoria jeho programovacie rozhranie, sú umiestnené hneď za popisom premenných. Takéto postupy a funkcie sú určené na použitie inými konfiguračnými objektmi alebo inými programami (napríklad prostredníctvom externého pripojenia), preto by sa mali nachádzať na „viditeľnom mieste“ v module.

Pozri tiež: Opis postupov a funkcií.

2.4.1 Obslužné programy udalostí, príkazy a prvky formulára . Pred servisnými procedúrami a funkciami v module formulár sú umiestnené obsluhy udalostí formulára, ako aj obsluhy udalostí pre príkazy a elementy formulára.

Metodické odporúčanie (užitočné rady)

Na paneli vlastností editora formulára sa odporúča umiestniť obslužné prvky jedného elementu formulára dohromady. v konfigurátore ,

2.4.2. Každá udalosť musí mať svoj vlastný postup pre obsluhu. Ak by sa rovnaké akcie mali vykonať, keď sa vyskytnú udalosti v rôznych prvkoch formulára:

• vytvoriť samostatnú procedúru (funkciu), ktorá vykonáva potrebné činnosti

• pre každý prvok formulára vytvorte samostatný obslužný program s predvoleným názvom

• zavolajte požadovaný postup (funkciu) od každého psovoda.

Napríklad nesprávne:

& OnClient postup výberu parametrov výberu ExecuteApplication (Element) = New Compliance (); Výber možností Paste („Podľa autora“, podľa autora); Výber možností Paste („Executive“, Executive); Nastaviť výber zoznamu (Zoznam, Možnosti výberu); KonetsProtsedury & Postup pre klienta na autorizáciu zmenou (elementu) na výkonnú zmenu (nedefinované); KonetsProtsedury

správne:

& OnClient Postup na vykonanie ukazovateľa (položka) SetSelection (); Ukončenie procedúry a procedúra podľa klienta Zmenou výberu (elementu) inštalácie (); Parametre výberu EndProcedures a OnServer SetSelection () = New Compliance (); Výber možností Paste („Podľa autora“, podľa autora); Výber možností Paste („Executive“, Executive); Nastaviť výber zoznamu (Zoznam, Možnosti výberu); KonetsProtsedury

Táto požiadavka je spôsobená skutočnosťou, že logika postupov obsluhy udalostí nie je určená na použitie v kóde modulu, ale je vyvolaná priamo platformou. Zmiešanie týchto dvoch scenárov do jedného postupu zbytočne komplikuje jeho logiku a znižuje jeho robustnosť (namiesto jedného predpokladaného scenára volania - pri udalosti z platformy - kód postupu sa musí počítať s ďalšími priamymi volaniami z kódu).

2.5. Obslužné programy udalostí pre objektové moduly a správcu objektov sú umiestnené po exporte, ale pred procedúrami pomocných programov a funkciami modulov.

Metodické odporúčanie (užitočné rady)

V popise zabudovaného jazyka sa odporúča umiestniť ovládače, ktorí dodržiavajú poradie ich sledovania.

2.6. Procedúry obslužného programu a funkcie modulu , ktoré nie sú obsluhovačom udalostí, ale predstavujú internú implementáciu modulu, sú umiestnené v module vedľa obsluhy udalostí.

V prípadoch, keď je spoločný modul súčasťou funkčného subsystému, ktorý obsahuje niekoľko objektov metaúdajov, môže táto časť obsahovať aj postupy a funkcie na export služieb, ktoré sa majú volať iba z iných objektov tohto subsystému.

Odporúča sa, aby sa postupy a funkcie, ktoré spolu súvisia podľa povahy alebo logiky práce, uvádzali spolu. Neodporúča sa explicitne zoskupovať procedúry a funkcie modulu do servera, klienta a funkcií bez kontextu, pretože takéto „technologické“ objednávanie komplikuje pochopenie logiky modulu, odkláňajúce pozornosť vývojára na podrobnosti jeho implementácie.

2.7. Sekcia inicializácie obsahuje príkazy, ktoré inicializujú premenné modulu alebo objektu (formy). Napríklad:

Adresa podpory = "[email protected]"; // Adresa na kontaktovanie technickej podpory Vykonajte inicializáciu ();

Ďalšie materiály na túto tému:
aktualizovať databázu , obsluhy udalostí , softvérové ​​rozhranie , manipulátory , postupy , šablóna , hlavička , koniec postupu , funkcie , rozhranie , popis , clipboard , kopírovať , časť , výmena , tvar , objekt , prvok , konfigurácia , konfigurácia , dokument

Materiály zo sekcie: 1C: Enterprise 8.2 / Vývojári / Dohody pri písaní kódu

Ďalšie materiály na túto tému:

Opis postupov a funkcií

Funkcie mierky pre vybraný objekt

Prenos konfigurácií na platforme 1C: Enterprise 8.2 na platformu 1C: Enterprise 8.3 bez režimu kompatibility s verziou 8.2

Názvy postupov a funkcií

Používanie privilegovaného režimu

Zistili sme: štruktúra modulu 1c je , servisné postupy a funkcie , modul, procedúra volania modulu manažéra 1c 8 2, ako volať procedúru z iného modulu 1c, hlavička anglického modulu, 1c zo procedúry volania modulu modulu, 1c 8 2 volanie procedúry z modulu manažéra, 1