Modulio struktūra

1C: Įmonė 8.2 /
Kūrėjams /
Kodekso konvencijos

Turinys

1.1. Programos modulyje (bendrieji moduliai, objektų moduliai, objekto valdytojų moduliai, formų, komandų ir kt. Moduliai) bendruoju atveju gali būti, kad toliau pateikiami sekantys skyriai: sekas :

Kai kurie skyriai gali būti tik tam tikro tipo moduliuose. Pvz., Įvykių tvarkytojai formų elementams gali būti pateikiami tik formų moduliuose, o kintamojo aprašymo sekcija ir inicijavimo sekcija negali būti apibrėžta ne visuotiniuose bendruosiuose moduliuose, objektų tvarkyklės moduliuose, įrašų rinkiniuose, pastoviosiose vertėse ir sesijos modulyje.

Reikalavimas padalinti modulio kodą į sekcijas skirtas padidinti kodo įskaitomumą ir supaprastinti skirtingų autorių kodo pakeitimų įvedimą ( kūrėjai ) kaip ir kolektyviniame vystyme, ir tobulinant taikomuosius sprendimus konkrečiam įgyvendinimui.

1.2. Bendrojo modulio skiltis (tuščia kopijavimui):

/////////////////////////////////////////////////////////////////// ////////////////////////////// // // //////////// /////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////// /////////////////////////////////////////////////////////////// // PROGRAMINĖS ĮRANGOS INTERFACE // /////////////////////////////////////////////////////////////////// //////////////////////////// // PASLAUGŲ PROCEDŪROS IR FUNKCIJOS

  • Skyriuje "Programos sąsaja" yra eksporto procedūrų ir funkcijų, skirtų naudoti kitiems konfigūravimo objektams ar kitoms programoms (pvz., Per išorinį ryšį).
  • Skyriuje "Naudingumo procedūros ir funkcijos" pateikiamos procedūros ir funkcijos, sudarančios bendrą modulio įgyvendinimą. Tais atvejais, kai bendras modulis yra dalis funkcionalus posistemiai, kuriuose yra keli metaduomenų objektai, šiame skyriuje taip pat gali apimti paslaugų eksporto procedūras ir funkcijas, skirtas tik skambinti iš kitų šio posistemio objektų.
    Bendrųjų modulių atveju rekomenduojama šį skirsnį padalyti į poskyrius pagal funkcinį atributą. Prieš poskyrius pateikiamas komentaras, kurį rekomenduojama išduoti panašiu būdu. Pavyzdžiui:

/////////////////////////////////////////////////////////////////// ////////////////////////////// // Informacijos bazės atnaujinimas

1.3. Objektų modulių, valdytojų, įrašų rinkinių, apdorojimo, ataskaitų ir tt sekcijų projektavimo šablonas:

/////////////////////////////////////////////////////////////////// //////////////////////////////// // PROGRAMINĖS ĮRANGOS INTERFACE ////////////// // /////////////////////////////////////////////////////////////////// ////////////// // RENGINIŲ PROCESAI //////////////////////////////// ///////////////////////////////////////////////////////////////// // // PASLAUGŲ PROCEDŪROS IR FUNKCIJOS

  • Skyriuje „Programos sąsaja“ yra eksporto procedūrų ir funkcijų, skirtų naudoti kituose konfigūracijos moduliuose ar kitose programose (pvz., Per išorinį ryšį). Į šį skyrių nereikia įtraukti eksporto funkcijų ir procedūrų, kurias ketinama vadinti tik iš paties objekto modulių, jų formų ir komandų. Pvz., Dokumento lentelės dalies, kuri yra pakviesta iš užpildymo apdorojimo objekto modulyje, ir dokumento formos formos komandų tvarkytojo tvarkymo procedūros nėra objekto modulio programos sąsaja, nes yra vadinami tik pačiame modulyje ir iš to paties objekto formų. Jie turėtų būti išdėstyti skyriuje „Naudingumo procedūros ir funkcijos“.
  • Skyriuje „Įvykių tvarkytojai“ yra objekto modulio įvykių tvarkytojai ( Prizavisi , PRO ir kt.)
  • Skyriuje "Naudingumo procedūros ir funkcijos" yra tas pats tikslas, kaip ir bendruosiuose moduliuose.

1.4. Formų modulių sekcijos dizaino šablonas:

/////////////////////////////////////////////////////////////////// /////////////////////////// / // FORMOS RENGINIŲ VYKDYTOJAS ///////////// /////////////////////////////////////////////////////////////////// /////////////// // FORMŲ RŪŠIŲ VYKDYMO REKOMENDACIJOS //////////////////////////// /////////////////////////////////////////////////////////////////// // // RENGINIŲ PROCESAI FORMOS LENTELĖS /////////////////////////////////////////////////////////////////// /////////////////////////////// / / / / // FORMŲ VADOVŲ PROCESAI /////// /////////////////////////////////////////////////////////////////// /////////////////////// // PASLAUGŲ PROCEDŪROS IR FUNKCIJOS

  • Skiltyje „Formų įvykių tvarkytojai“ pateikiamos formos įvykių tvarkytojo procedūros: serverio kūrimas , atidarymas ir kt.
  • Skyriuje „Formos elementų tvarkytojai“ pateikiamos pagrindinės formos dalies elementų tvarkymo procedūros (viskas, kas nesusijusi su formos lentelėmis).
  • Skiltyse „Formos lentelės įvykių tvarkytojai <formų lentelės pavadinimas>“ yra procedūros formos lentelės ir lentelės elementų tvarkytojams. Tvarkyklų procedūroms kiekviena lentelė turi turėti savo skaidinį.
  • Skyriuje „Formos komandų tvarkytojai“ pateikiamos formos komandų tvarkytojų procedūros (kurių pavadinimai nurodyti formų komandų veiksmo ypatybėse).
  • Skyriuje "Naudingumo procedūros ir funkcijos" yra tas pats tikslas, kaip ir bendruosiuose moduliuose.

Taip pat žiūrėkite: Formos modulių kūrimo taisyklės

2. Bendrieji reikalavimai programinės įrangos modulių skyriams.

2.1. Modulio antraštė yra komentaras pačiame modulio pradžioje. Modulio antraštėje pateikiamas trumpas aprašymas ir taikymo sąlygos.
Pavyzdžiui:

/////////////////////////////////////////////////////////////////// //////////////////////////// // // Bendrosios paskirties kliento procedūros ir funkcijos: // - darbui su formų sąrašais; // - dirbti su žurnalu; // - apdorojimo veiksmams naudotojas vyksta redagavimas // daugialypis tekstą , pavyzdžiui, komentarai dokumentuose; // - kita. // /////////////////////////////////////////////////////////////////// ////////////////////////////////

Formų moduliams rekomenduojama formų parametrų aprašą pateikti antraštėje

2.2. Kintamasis aprašymas . Kintamieji pavadinimai priskiriami pagal bendrą kintamojo pavadinimo taisyklės , ir jų naudojimas aprašytas straipsnyje. Naudojant pasaulinius kintamuosius programinės įrangos moduliuose .

Visiems modulio kintamiesiems turėtų būti pateiktas komentaras, kad būtų galima suprasti jų paskirtį. Komentaras rekomenduojamas toje pačioje eilutėje, kurioje yra deklaruojamas kintamasis.
Pavyzdys:

„Pem CurrencyAccounting Export“; // Valiuta, kurioje tvarkoma buhalterinė apskaita. // El. Pašto adresas, kuriame siunčiami klaidos pranešimai

2.3. Programinės įrangos sąsaja Eksporto procedūros ir funkcijos, sudarančios programavimo sąsają, pateikiamos iškart po kintamųjų aprašymo. Tokios procedūros ir funkcijos yra skirtos naudoti kitiems konfigūravimo objektams ar kitoms programoms (pvz., Per išorinį ryšį), todėl jie turėtų būti matomoje vietoje modulyje.

Taip pat žiūrėkite: Procedūrų ir funkcijų aprašymas.

2.4.1 Formos įvykių tvarkytojai, komandos ir formos elementai . Prieš atliekant formų modulio aptarnavimo procedūras ir funkcijas, yra formų įvykių tvarkytojai, taip pat komandų ir formos elementų renginių tvarkytojai.

Metodinė rekomendacija (naudingi patarimai)

Rekomenduojama, kad vienos formos elementų tvarkytojai būtų išdėstyti kartu, laikydamiesi formos sekos formos redaktoriaus nuosavybės skydelyje. konfigūratoriuje .

2.4.2. Kiekvienas įvykis turi turėti savo tvarkytojo procedūrą. Jei tie patys veiksmai turėtų būti atliekami, kai įvykiai vyksta įvairiuose formos elementuose:

  • sukurti atskirą procedūrą (funkciją), kuri atliktų reikiamus veiksmus

  • kiekvienam formos elementui sukurkite atskirą tvarkyklę su numatytuoju pavadinimu

  • skambinkite reikiama procedūra (funkcija) iš kiekvieno tvarkytojo.

Pavyzdžiui, neteisingai:

& OnClient procedūra vykdymo (elemento) pasirinkimo parametrų vykdymui = Naujas atitikimas (); Parinkčių parinkimas. Įklijuoti („Autorius“, Autorius); Pasirinkimo parinktys. Nustatyti sąrašo pasirinkimą (sąrašas, pasirinkimo parinktys); „EndProcedure“ & Dėl kliento procedūros, leidžiančios keisti (elementas) į vykdomąjį narį keičiant (neapibrėžtas); „EndProcedure“

teisinga:

& OnClient procedūra atlikti rodiklį (elementą) SetSelection (); Pabaigos procedūra ir kliento procedūra pagal autoriaus pakeitimo (elemento) diegimo pasirinkimą (); EndProcedures & OnServer procedūra SetSelection () pasirinkimo parametrai = New Compliance (Naujas atitikimas) (); Parinkčių parinkimas. Įklijuoti („Autorius“, Autorius); Pasirinkimo parinktys. Nustatyti sąrašo pasirinkimą (sąrašas, pasirinkimo parinktys); „EndProcedure“

Šis reikalavimas kyla dėl to, kad įvykių tvarkytojo procedūrų logika nėra skirta naudoti modulio kode, bet platforma ją tiesiogiai vadina. Šių dviejų scenarijų maišymas vienoje procedūroje nereikalingai apsunkina jo logiką ir sumažina jos patikimumą (vietoj vieno numatyto skambučio scenarijaus - įvykio iš platformos - procedūros kodas turi būti skaičiuojamas pagal kitus tiesioginius skambučius iš kodo).

2.5. Objektų modulių ir objekto tvarkyklės įvykių tvarkytojai pateikiami po eksporto, bet prieš naudingųjų procedūrų ir modulio funkcijas.

Metodinė rekomendacija (naudingi patarimai)

Rekomenduojama įterptosios kalbos aprašyme laikyti tvarkykles, laikydamiesi jų tvarkos.

2.6. Priemonės procedūros ir modulio funkcijos , kurios nėra įvykių tvarkytojai, bet sudaro vidinį modulio įgyvendinimą, yra pateikiamos modulyje šalia įvykių tvarkytojų.

Tais atvejais, kai bendras modulis yra funkcinio posistemio, apimančio kelis metaduomenų objektus, dalis, šiame skyriuje taip pat gali būti paslaugų eksporto procedūros ir funkcijos, skirtos tik skambinti iš kitų šio posistemio objektų.

Rekomenduojama, kad tarpusavyje susijusios procedūros ir funkcijos, susijusios su darbo pobūdžiu ar logika, būtų pateikiamos kartu. Nerekomenduojama aiškiai susisteminti modulio procedūras ir funkcijas be serverio, kliento ir funkcijų, nes toks „technologinis“ užsakymas apsunkina modulio logikos supratimą, nukreipdamas kūrėjo dėmesį į jo įgyvendinimo detales.

2.7. Inicializacijos skiltyje pateikiami teiginiai, inicijuojantys modulio arba objekto (formos) kintamuosius. Pavyzdžiui:

Palaikymo adresas = "[email protected]"; // Adresas susisiekti su technine pagalba Atlikti inicijavimą ();

Kitos temos medžiagos:
atnaujinti duomenų bazę , įvykių tvarkytojai , programinės įrangos sąsaja , tvarkytojai , procedūras , modelį , antraštė , procedūros pabaiga , funkcijos , sąsaja , aprašymas , iškarpinę , kopijuoti , skyriuje , keistis , formos , objektas , elementą , konfigūravimas , konfigūracijos , dokumentą

Medžiagos iš sekcijos: 1C: „Enterprise 8.2“ / kūrėjai / susitarimai rašant kodą

Kitos temos medžiagos:

Procedūrų ir funkcijų aprašymas

Pasirinkto objekto mastelio keitimo funkcijos

1C: Enterprise 8.2 platformos konfigūracijų perkėlimas į 1C: Enterprise 8.3 platformą be suderinamumo režimo su 8.2 versija

Procedūrų ir funkcijų pavadinimai

Naudojant privilegijuotą režimą


Mes randame: 1c modulio struktūra , paslaugų teikimo procedūros ir funkcijos , modulis, vadybininko modulio skambučių procedūra 1c 8 2, kaip skambinti procedūra iš kito modulio 1c, anglų modulio antraštė, 1c iš apdorojimo formos skambučio modulio procedūros, 1c 8 2 skambinti procedūrai iš administratoriaus modulio, 1


1C: Įmonė 8