Cod de frecvență într-un limbaj de program. Cod program

Pentru ca programul să efectueze acțiunile prescrise, de exemplu, să calculeze, să afișeze rezultatul, să răspundă la acțiunile utilizatorului, de exemplu, apăsarea butoanelor, selectarea liniilor dintr-o listă, este necesar codul programului.

Cod program este un set de cuvinte și simboluri ale unui limbaj de programare.

Alfabet - acesta este un set complet de litere, numere și simboluri adoptate în limbă pentru a denota date și acțiuni asupra acestora.

Alfabetul limbajului Visual Basic include următorul set de caractere:

Litere mari (A - Z) și mici (a - z) ale alfabetului latin;

Numerele de la 0 la 9;

Semne ale operațiilor aritmetice (în ordine crescătoare de prioritate): +, -, *, /, |, ^;

Semne ale operațiilor relaționale: =,<, >.

Semne de punctuație și separatoare: ,  . : ; ();

Alfabetul limbii include și rezervat cuvinte care nu pot fi folosite ca nume variabile sau proceduri. Exemple de cuvinte rezervate: Dim, Sub, Integer etc. În mod implicit, fontul albastru este folosit pentru a evidenția cuvintele cheie în fereastra de editare a codului Visual Basic.

Cuvintele și simbolurile trebuie scrise strict conform regulilor limbii, fără erori de ortografie și de punctuație. Este scrierea exactă care va permite computerului să înțeleagă și să execute fără ambiguitate programul.

Fereastra de cod

Codul programului este scris în fereastra de cod. Fiecare formular are o astfel de fereastră.

Deschide fereastra de cod:

1 cale - La fereastră Explorator de proiecte clic Click dreaptaîn forma necesară și selectați în meniul care se deschide Afișați codul.

Notă: Este posibil ca fereastra de cod să nu fie asociată cu formularul. Fereastra de cod separată este numită Modul. Modulele din fereastra Project Explorer sunt grupate într-un grup Module. Pentru a deschide o fereastră cu codul modulului, trebuie să în fereastră Explorator de proiecte faceți dublu clic pe numele modulului.

Metoda 2 - faceți dublu clic pe elementul de control din formular sau pe formularul propriu-zis din fereastra formularului.

Notă: aceasta nu numai că deschide fereastra de cod, dar creează și o procedură de gestionare a evenimentelor (vezi mai jos).

Structura ferestrei de cod:

Orez. 7. Fereastra cod program.

Lista de controale

Lista evenimentelor de control

Procedura (cod)

Proceduri

Deoarece atunci când frigiderul este deschis, lampa se aprinde, iar când robinetul este deschis, apa curge afară, putem spune că atunci când are loc evenimentul deschiderii frigiderului, se efectuează o procedură, iar evenimentul deschiderii robinetului determină alta. procedură. De asemenea codul programului constă din proceduri separate, fiecare dintre ele efectuând propriile acțiuni specifice, de exemplu, o procedură aprinde o lampă, cealaltă pornește (pompează) apa.

Visual Basic - limbaj de programare procedural. Aceasta înseamnă că puteți crea blocuri de cod în el, care pot fi apoi referite după nume. Odată ce un bloc de cod are un nume, acesta poate fi numit si completat. Este ca un program în cadrul unui program. Se numesc programele mici care „trăiesc” în programe mari funcţii dacă ele returnează o oarecare valoare și subrutine, dacă nu returnează valori.

Subrutinele și funcțiile fac programarea mai ușoară și mai rapidă, iar codul pe care îl creați mai fiabil. Crearea propriilor rutine și funcții este primul pas către dezvoltare încapsulatși cod reutilizabil. Încapsularea înseamnă ascunderea implementării proprietăților și metodelor unui obiect în spatele interfeței sale externe.

Procedură (subrutina) este un fragment separat de cod de program cu ajutorul căruia se rezolvă de obicei o sarcină mică; este un bloc de program mic construit logic, în care este împărțit întregul program.

Dacă o procedură poate fi executată numai într-un anumit bloc de program (de exemplu, numai în această formă) și nu poate fi apelată dintr-un alt bloc de program, atunci o astfel de procedură este locală. O procedură locală este specificată folosind cuvântul cheie Private Sub.

Dacă o procedură poate fi apelată din alte blocuri de program (de exemplu, dintr-un alt formular), atunci o astfel de procedură este globală. O procedură globală este specificată folosind cuvântul cheie Public Sub.

În mod implicit, dacă înainte de cuvântul cheie Sub, nu există cuvânt cheie, atunci aceasta este o procedură globală.

Procedurile sunt:

Proceduri de eveniment. Executat atunci când are loc un eveniment pe un control (sau formular). O procedură de eveniment este întotdeauna asociată cu un obiect. Pentru a apela procedura de eveniment a unui obiect, faceți dublu clic stânga pe obiect.

Proceduri arbitrare. Nu este asociat cu evenimente și poate fi apelat din orice altă procedură și executat în orice moment. Dacă același bloc de program apare în toate formele dintr-un program, atunci acesta poate fi scris o singură dată și într-un singur loc, sub forma unui program comun global. Lansarea unui program general nu este asociată cu un obiect și cu un eveniment, ci are loc atunci când este accesat din alte blocuri de program. Apelarea unei proceduri generale din același formular: ProcedureName (ParameterList). Apelarea unei proceduri generice dintr-un alt formular: UN OBIECT. ProcedureName (ParameterList). Procedura generală poate fi atât Privată locală, cât și Publică globală

Structura procedurii

Procedura constă din următoarele elemente:

Antetul procedurii - marchează începutul procedurii, tipul acesteia, scopul (evenimentul).

Un exemplu de titlu de procedură care este executat atunci când se face clic pe un buton numit Command1.

Cuvânt Privatînseamnă închis, adică procedura aparține numai acestui formular sau modul și nu poate fi utilizată de alte containere (formulare, module). Dacă acest cuvânt este omis, procedura va fi deschisă altor containere.

Sub- procedură.

Notă: Pe lângă proceduri, există și funcții. Funcțiile nu sunt asociate cu evenimente și pot returna în plus rezultatul muncii lor (calcule).

Element de control(sau numele formularului): Acesta specifică numele exact al elementului stocat în proprietate Nume.

Eveniment- denumirea evenimentului. Iată câteva evenimente:

Click - click mouse;

DblClick - dublu click mouse;

KeyPress - apăsare taste;

UnLoad - descărcarea formularului (la închiderea formularului, terminarea programului);

Activare - activarea formularului (când dați clic pe formular și titlul acestuia este evidențiat);

Dezactivare - dezactivați formularul (când dați clic pe alt formular).

Initialize - la crearea unui obiect de tip formular.

Redimensionare - la modificarea dimensiunii formularului

Încetare - în momentul ștergerii formularului

Argumente- acestea sunt datele inițiale trecute în procedura de prelucrare.

Procedurile personalizate au următorul antet:

Numele procedurii acolo trebuie sa fie unic, trebuie să înceapă cu o literă și nu trebuie să conțină spații sau caractere, altele decât liniuțe de subliniere. Procedura este numită după nume atunci când trebuie executată.

Sfârșitul procedurii - încheie codul de program al procedurii: End Sub

Notă: pentru funcții: End Function

Organul de procedură - acestea sunt liniile dintre titlu și final. Numărul lor este nelimitat. Liniile conțin instrucțiuni care trebuie executate atunci când procedura este apelată (se produce evenimentul).

Subrutină (Sub) - este o procedură care execută cod de program în blocul său și nu returnează o valoare. Sintaxa unei subrutine simple este:

( Privat | Public ) Sub SubMain ()

..linii de cod Sfârşit Sub

Domeniul de aplicare al subrutinei;

Sub - tip de procedură (și anume, subrutină);

subMain numele dat subrutinei;

End Sub - sfârșitul blocului de cod al subrutinei.

Crearea unei proceduri

Pentru a crea o procedură, procedați în felul următor:

1 cale - faceți dublu clic pe controlul sau formularul dorit. Se va deschide fereastra de cod, iar titlul și sfârșitul procedurii vor apărea în ea. Dacă este necesar un alt eveniment, acesta este selectat folosind lista din colțul din dreapta sus al ferestrei de cod.

Metoda 2 - deschideți fereastra de cod, mergeți la Tools → Add Procedure → specificați numele și parametrii procedurii → Ok.

3 căi - deschideți fereastra de cod și introduceți liniile necesare de la tastatură.

Rezultatul ar trebui să fie:

Subcomandă privată1_Click()

Apelarea procedurilor pentru executare

Pentru ca o procedură de eveniment să se execute, evenimentul trebuie să aibă loc.

Pentru a executa o procedură arbitrară, specificați numele acestei proceduri în corpul altei proceduri.

Subcomandă privată1_Click()

Aici, când faceți clic pe butonul Command1, apare evenimentul Click și procedura Kvadrat este apelată și executată.

Codul procedurii este executat linie cu linie și de sus în jos.

Funcția (Funcţie) - este o procedură care execută linii din codul său și returnează o anumită valoare. Sintaxa pentru o funcție simplă este:

Funcţie FunctionName() Ca tip de date

... liniicod

FunctionName = ReturnValueFuncția de sfârșit

Domeniul de aplicare al funcției;

Funcție este un cuvânt cheie Visual Basic care indică faptul că este o funcție;

FunctionName () - numele dat funcției;

AS este un cuvânt cheie Visual Basic care precede atribuirea unui tip de date;

DataType tipul de date pentru valoarea returnată;

Valoare returnată valoarea care ar trebui să fie atribuită numelui funcției (acesta este un punct foarte important!);

End Function - sfârșitul acestui bloc de cod.

Astăzi, multe companii, precum și persoane fizice, simt nevoia să aibă propriul site web, motiv pentru care informațiile pe tema dezvoltării și promovării proiectelor pe Internet sunt atât de solicitate. Mulți oameni sunt interesați de întrebarea - cum să vă creați propriul dvs site-ul web, codul programului pentru care este ca o fundație pentru o casă? Să încercăm să înțelegem această problemă aprofundând în subiectul dezvoltării web.

Un site web nu este doar o colecție de text, link-uri, imagini și bannere colorate, este și un cod de program care rulează pe computerul utilizatorului sau pe partea serverului. Și dacă creați imagini cu formatul necesar în rezoluția necesarăși calitate astăzi, aproape toată lumea poate folosi imagini gata făcute de pe Internet sau de la orice populară editor grafic, apoi creează codul site-ului pentru un nespecialist este plin de dificultăți considerabile.

Calitatea aplicațiilor și a proiectului Internet în ansamblu depinde în mare măsură de priceperea programatorului care dezvoltă site-ul, al cărui cod de program poate conține erori care afectează foarte mult viteza de încărcare a paginilor web și multe alte aspecte ale funcționării întregului site. site-ul, inclusiv cele legate de securitate. Prin urmare, detectarea și eliminarea erorilor din cod este o componentă obligatorie la crearea oricărui site web. Cel mai bine este să încredințați specialiștilor dezvoltarea unui site web corporativ complex (dacă nu sunteți unul), deoarece unele erori sunt greu de detectat, iar multe dintre ele pot duce în continuare la încărcarea lentă și afișarea incorectă a paginilor web în browserele de calculatoarele utilizatorilor de internet. Prea mult încărcare lungă poate provoca o ieșire de vizitatori de pe site și o scădere a calității traficului, ceea ce reduce profitul și eficiența utilizării proiectelor comerciale de internet.

HTML și CSS mai întâi

Baza unui document web este codul scris în limbajul de marcare HTML. Un limbaj de marcare nu trebuie confundat cu un limbaj de programare și care este diferența reală este scrisă în detaliu. În principiu, folosind setul de comenzi pe care HTML-ul îl oferă dezvoltatorului site-ului, puteți seta toți parametrii necesari ai unui document web static - aranjarea elementelor (marcare bloc), titluri, paragrafe, tabele, imagini etc. Si cu folosind CSS, un add-on special pentru HTML, puteți poziționa toate obiectele de marcare listate, le puteți schimba stilul - culoare, dimensiune, format etc.

Apoi JavaScript

Elemente interactive și animate, de exemplu - bannere, ticker, formular părere, pe paginile web funcționează datorită prezenței scripturilor și a codului scris în limbaje de programare pe partea de server sau pe partea clientului. Scripturile dezvoltate folosind limbajul sunt foarte populare Programare JavaScript. Astfel de scripturi client nu folosesc capacitățile serverului în munca lor și sunt executate pe partea laterală a computerului utilizatorului, adică în browser. Astfel aplicații JavaScript se caracterizează prin simplitate şi de mare viteză muncă.

Și în sfârșit PHP

Când este necesar să scrieți coduri complexe și voluminoase, de exemplu pentru forumuri sau cărți de oaspeți, programatorii apelează la limbaje de programare de pe server pentru ajutor, și în special la . Codurile PHP sunt executate pe partea de server, astfel încât activitatea lor poate fi puțin mai lentă, în funcție de viteza conexiunii cu computer la distanțăși gradul sarcinii sale de muncă. CU folosind PHPși comenzi SQL (un limbaj de interogare special pentru o bază de date relațională), puteți organiza interacțiunea unui site cu baze de date și puteți crea proiecte interactive pe Internet - forumuri, magazine online, panouri de mesaje, diverse directoare etc.

Nu vă faceți griji prea mult în legătură cu ce limbă ar trebui să alegeți să învățați. Mulți programatori începători le este dificil să aleagă o limbă atunci când încep să învețe să scrie coduri software. Limba reală pe care o alegeți nu contează când vine vorba de învățarea structurilor și a logicii de construire a informațiilor. Aceste abilități sunt mult mai importante și pot fi învățate cu orice limbaj de programare.

Atunci când alegeți o limbă, concentrați-vă pe scopul pentru care doriți să creați coduri de program și abia apoi alegeți o limbă de pornire. De exemplu, dacă doriți să dezvoltați site-uri web, atunci ar trebui să începeți prin a învăța HTML și apoi să îl completați cu CSS, JavaScript și PHP. Dacă doriți să creați programe pentru computere, atunci începeți să învățați C++ sau orice alt limbaj de programare de bază.
Dacă devii un programator profesionist, vei realiza rapid că nu vei folosi niciodată limbajul pe care l-ai învățat inițial pentru munca ta. În schimb, veți continua să învățați noi limbi prin documentare și experimentare tot timpul.

Găsiți resurse online gratuite specifice limbii alese. Internetul este un cufăr de comori de tutoriale gratuite, cursuri și videoclipuri dedicate limbii pe care alegi să o înveți. Puteți învăța elementele de bază ale aproape oricărei limbi introductive într-o zi.

Iată doar câteva site-uri populare: Bento, CodeAcademy, Code.org, html.net, Khan Academy, Udacity, W3Schools și multe altele.
wikiHow are, de asemenea, o mare varietate de tutoriale de pornire pentru diferite limbi.
Puteți găsi videoclipuri educaționale pentru aproape orice limbă pe YouTube.
Stack Exchange este unul dintre cele mai populare forumuri unde programatorii profesioniști răspund la orice întrebări din partea utilizatorilor.

Descărcați un editor de text bun. Multe limbaje de programare permit utilizarea externă editori de text pentru scrierea programelor. Găsiți un editor de text care va afișa indentarea și marcarea codului.

Programele populare includ Notepad++ (Windows), TextWrangler (OS X) și JEdit (orice sistem).

Descărcați orice compilatoare necesare. Unele limbaje de programare necesită un compilator pentru a afișa codul sursă pe care l-ați scris. Compilatorii traduc codul sursă într-un program de limbaj echivalent de nivel scăzut, care este apoi procesat de computer. Multe compilatoare sunt open source și programe gratuite. Limbile care necesită utilizarea compilatoarelor includ:

DE BAZĂ
Fortran
Pascal

Începe primul tău proiect. Alegeți un proiect introductiv bun care vă va permite să vă încercați noile abilități. Există multe oferte și tutoriale pe această temă pe Internet; de exemplu, puteți începe prin a crea site-uri web simple cu HTML, baze de date simple și funcții cu PHP sau programe simpleîn oricare dintre limbile care necesită utilizarea compilatoarelor.

Scop

Sursă fie folosit pentru a produce cod obiect, fie executat de un interpret. Modificările nu se fac niciodată codului obiect, ci doar codului sursă și apoi sunt convertite înapoi în cod obiect.

Un alt scop important al codului sursă este descrierea unui program. Pe baza textului programului, puteți reconstrui logica comportamentului acestuia. Comentariile sunt folosite pentru a face codul sursă mai ușor de înțeles. Există și instrumente care vă permit să obțineți automat documentația codului sursă - așa-numita. generatoare de documentație.

În plus, codul sursă are multe alte utilizări. Poate fi folosit ca instrument de predare; Programatorii începători pot considera că este util să examineze codul sursă existent pentru a învăța tehnicile și metodologia de programare. De asemenea, este folosit ca instrument de comunicare între programatori experimentați datorită naturii sale concise și lipsite de ambiguitate. Partajarea Administrarea codului este adesea citată de dezvoltatori ca un factor care contribuie la îmbunătățirea experienței programatorului.

Programatorii mută adesea codul sursă (în module, ca atare sau cu adaptări) de la un proiect la altul, ceea ce se numește reutilizare a codului.

Codul sursă este o componentă critică pentru procesul de portare a software-ului pe alte platforme. Fără codul sursă al oricărei piese de software, portarea este fie prea dificilă, fie complet imposibilă.

Organizare

Codul sursă al unei părți a software-ului (modul, componentă) poate consta din unul sau mai multe fișiere. Codul programului nu este neapărat scris într-un singur limbaj de programare. De exemplu, adesea programele scrise în limbaj C, în scopuri de optimizare, conțin inserții de cod în limbaj de asamblare. De asemenea, este posibil ca unele componente sau părți ale unui program să fie scrise în limbi diferite și apoi asamblate într-un singur modul executabil folosind o tehnică cunoscută sub numele de linking bibliotecă ( legarea bibliotecii).

Complex software când este asamblat, necesită utilizarea a zeci sau chiar sute de fișiere de cod sursă. În astfel de cazuri, pentru a simplifica construirea, sunt utilizate de obicei fișiere de proiect care conțin o descriere a dependențelor dintre fișierele de cod sursă și descriu procesul de construire. Aceste fișiere pot conține, de asemenea, opțiuni pentru compilator și mediul de proiectare. Pentru diferite medii de proiectare, pot fi utilizate diferite fișiere de proiect, iar în unele medii aceste fișiere pot fi într-un format text, potrivit pentru editarea directă de către un programator folosind editori de text universali; în alte medii, sunt acceptate formate speciale, iar crearea și modificarea fișierelor se realizează cu ajutorul programelor de instrumente speciale. Fișierele de proiect sunt de obicei incluse în termenul „cod sursă”. Marea majoritate a mediilor de limbaj moderne necesită utilizarea fișierelor de proiect, indiferent de complexitatea celuilalt cod sursă inclus în proiect. Adesea, codul sursă înseamnă și fișiere de resurse care conțin diferite date, de exemplu, imagini grafice, necesare pentru a construi programul.

Pentru a facilita lucrul cu codul sursă, pentru colaborarea la cod de către o echipă de programatori, se folosesc sisteme de control al versiunilor.

Calitate

Spre deosebire de oameni, nu există un cod „bine scris” sau „prost scris” pentru un computer. Dar modul în care este scris codul poate influența foarte mult procesul de întreținere a software-ului. Calitatea codului sursă poate fi apreciată după următorii parametri:

lizibilitatea codului (inclusiv prezența comentariilor la cod);
ușurință de asistență, testare, depanare și depanare, modificare și portare;
utilizarea economică a resurselor - memorie, procesor, spațiu pe disc;
absența comentariilor emise de compilator;
absența „gunoaielor” - variabile neutilizate, blocuri de cod inaccesibile, comentarii învechite inutile etc.;
tratarea adecvată a erorilor;
portabilitate - abilitatea de a utiliza un handler (compilator, interpret, traducător) versiuni diferite, sau chiar un sistem de operare diferit;
posibilitatea de internaționalizare a interfeței.

Cod sursă neexecutabil

Licențele copyleft pentru software gratuit necesită distribuirea codului sursă. Aceste licențe sunt adesea folosite și pentru lucrări care nu sunt software - de exemplu, documentație, imagini, fișiere de date pentru jocuri pe calculator.

În astfel de cazuri, codul sursă este considerat a fi forma lucrării care este preferată pentru editare. În alte licențe decât software, aceasta poate fi denumită și versiunea „format transparent”. Acesta ar putea fi, de exemplu:

pentru un fișier comprimat cu pierdere de date - versiunea fără pierderi;
pentru redarea unei imagini vectoriale sau a unui model tridimensional - respectiv, versiunea vectorială și modelul;
pentru o imagine text - același text în format text;
pentru muzică - un fișier în formatul intern al editorului muzical;
și, în sfârșit, fișierul în sine, dacă îndeplinește condițiile specificate sau dacă pur și simplu nu a existat o versiune mai convenabilă.

Vezi si

Fundația Wikimedia. 2010.

Vedeți ce este „Codul sursă” în alte dicționare:

Materiale sursă ale filmului: negativ, contratipărire, copie de control a filmului, fonograme magnetice originale de dublare muzicală, zgomot, master video fonogramă, CD etc. Sinonime: textul este fie executat direct de interpret, fie... ... Dicţionar financiar

Text scris uman program de calculatorîn orice limbaj de programare Dicţionar de termeni de afaceri. Akademik.ru. 2001... Dicţionar de termeni de afaceri

sursă- - Subiecte telecomunicații, concepte de bază Cod sursă EN... Ghidul tehnic al traducătorului

sursă- 3.1.13 cod sursă: un program de calculator exprimat într-o formă care poate fi citită de om (limbaj de programare) care este tradus în formă care poate fi citită de mașină (codul obiect) înainte de a putea fi testat cu... ... Dicționar-carte de referință de termeni ai documentației normative și tehnice

sursă- limba textului sursă... Dicționar de traducere explicativă

Cod sursă: Codul sursă este textul scris de om al unui program de calculator. Tehno-thriller cu cod sursă regizat de Duncan Jones ... Wikipedia

Acest termen are alte semnificații, vezi codul sursă. Cod sursă Cod sursă ... Wikipedia

Acest articol nu are link-uri către surse de informații. Informațiile trebuie să fie verificabile, altfel pot fi puse sub semnul întrebării și șterse. Poți... Wikipedia

Logo-ul Open Source Initiative (OSI) Software-ul cu sursă deschisă este un software cu sursă deschisă. Sursă programe create deschis, adică disponibil pentru vizualizare și modificare. Aceasta este... ... Wikipedia

Program sursă (cod sursă)- 48) program sursă (cod sursă) o reprezentare corespunzătoare a unuia sau mai multor procese care pot fi convertite de un sistem de programare într-o formă executabilă de hardware (cod obiect sau limbaj obiect) (categorii 6, 7 și 9); ... Terminologie oficială

15 Reguli pentru scrierea codului de calitate

Există nenumărate moduri de a scrie cod prost. Din fericire, pentru a ajunge la nivelul codului de calitate, trebuie doar să urmați 15 reguli. Urmărirea lor nu te va face un maestru, dar îți va permite să-l imiti în mod convingător.

Regula 1: Urmați standardele de codare.

Fiecare limbaj de programare are propriul standard de formatare a codului, care spune cum să indentați, unde să puneți spații și paranteze, cum să denumiți obiectele, cum să comentați codul etc.

De exemplu, în această bucată de cod, conform standardului, există 12 erori:

Pentru(i=0;i

Studiați standardul cu atenție, învățați elementele de bază pe de rost, urmați regulile precum poruncile și programele dvs. vor fi mai bune decât cele mai multe scrise de absolvenți de facultate.

Multe organizații își adaptează standardele pentru a se potrivi nevoilor lor specifice. De exemplu, Google a dezvoltat standarde pentru mai mult de 12 limbaje de programare. Sunt bine gândite, așa că verificați-le dacă aveți nevoie de ajutor pentru programare cu Google. Standardele includ chiar setări ale editorului pentru a vă ajuta să respectați stilul și instrumente speciale pentru a verifica dacă codul dvs. este conform cu acel stil. Utilizati-le.

Regula 2: Dați nume descriptive.

Limitați de mașini de teletip lente și greoaie, programatorii din antichitate foloseau contracte pentru nume de variabile și proceduri pentru a economisi timp, apăsări de taste, cerneală și hârtie. Această cultură este prezentă în unele comunități de dragul menținerii compatibilității cu versiunile inverse. Luați, de exemplu, funcția C wcscspn, care rupe limbajul (interval de completare a șirurilor de caractere). Dar această abordare nu este aplicabilă în codul modern.

Utilizați nume lungi și descriptive, cum ar fi complementSpanLength, pentru a vă ajuta pe dvs. și colegii să înțelegeți codul în viitor. Excepțiile sunt câteva variabile importante utilizate în corpul unei metode, cum ar fi iteratoarele de buclă, parametrii, valorile temporare sau rezultatele execuției.

Este mult mai important să te gândești mult înainte de a numi ceva. Numele este corect? Ați vrut să spuneți cel mai mare preț sau cel mai bun preț? Este numele suficient de specific pentru a evita utilizarea lui în alte contexte pentru obiecte similare? Nu ar fi mai bine să apelați metoda getBestPrice în loc de getBest? Se potrivește mai bine decât alte nume similare? Dacă aveți o metodă ReadEventLog, nu ar trebui să apelați un alt NetErrorLogRead. Dacă denumiți o funcție, numele descrie valoarea returnată?

În concluzie, câteva reguli simple denumire. Numele de clase și de tip trebuie să fie substantive. Numele metodei trebuie să conțină un verb. Dacă o metodă determină dacă unele informații despre un obiect sunt adevărate sau false, numele acesteia trebuie să înceapă cu „este”. Metodele care returnează proprietățile obiectelor trebuie să înceapă cu „get”, iar metodele care stabilesc valorile proprietăților trebuie să înceapă cu „set”.

Regula 3: Comentariu și document.

Începeți fiecare metodă și procedură descriind într-un comentariu ce aceasta metoda sau procedura nu, parametrii, valoarea returnată și posibile erori si exceptii. Descrieți în comentarii rolul fiecărui fișier și clasă, conținutul fiecărui câmp de clasă și pașii principali ai codului complex. Scrieți comentarii pe măsură ce dezvoltați codul. Dacă crezi că le vei scrie mai târziu, te înșeli singur.

În plus, asigurați-vă că aplicația sau biblioteca dvs. are un manual care explică ce face codul dvs., definește dependențele acestuia și oferă instrucțiuni pentru construirea, testarea, instalarea și utilizarea acestuia. Documentul trebuie să fie scurt și convenabil; un simplu fișier README este adesea suficient.

Regula 4. Nu te repeta.

Nu copiați și lipiți niciodată cod. În schimb, izolați partea comună într-o metodă sau clasă (sau macro, dacă este necesar) și utilizați-o cu parametrii corespunzători. Evitați utilizarea datelor și a fragmentelor de cod similare. Utilizați, de asemenea, următoarele tehnici:

Generați referințe API din comentarii folosind Javadoc și Doxygen.
Generarea automată de teste unitare bazate pe adnotări sau convenții de denumire.
Generați PDF și HTML dintr-o singură sursă etichetată.
Preluarea structurii clasei din baza de date (sau invers).

Regula 5: Verificați erorile și răspundeți la ele.

Metodele pot returna simptome de eroare sau pot arunca excepții. Procesați-le. Nu te baza pe faptul că discul nu se va umple niciodată, fișierul tău de configurare va fi mereu acolo, aplicația ta va rula cu toate drepturile de care are nevoie, cererile de alocare a memoriei vor reuși întotdeauna sau că conexiunea ta nu va eșua niciodată. Da, buna prelucrare erorile sunt greu de scris și fac codul mai lung și mai greu de citit. Dar ignorarea erorilor pur și simplu mătură problema sub covor, unde un utilizator nebănuit o va descoperi într-o zi.

Regula 6: Împărțiți codul în părți scurte, discrete.

Fiecare metodă, funcție sau bloc de cod ar trebui să se încadreze într-o fereastră obișnuită a ecranului (25-50 de linii). Dacă este mai lung, împărțiți-l în bucăți mai scurte. Chiar și în cadrul unei metode, împărțiți codul lung în blocuri, a căror esență o puteți descrie într-un comentariu la începutul fiecărui bloc.

Mai mult, fiecare clasă, modul, fișier sau proces trebuie să îndeplinească un anumit tip de sarcină. Dacă o bucată de cod îndeplinește sarcini complet diferite, atunci împărțiți-o în consecință.

Regula 7. Utilizați API-uri cadru și biblioteci terțe.

Explorați ce caracteristici sunt disponibile prin intermediul API-ului cadrului dvs. și, de asemenea, ce pot face bibliotecile mature terțe. Dacă bibliotecile sunt acceptate de managerul de pachete de sistem, atunci cel mai probabil vor fi buna alegere. Folosește un cod care descurajează dorința de a reinventa roata (și unul pătrat inutil).

Regula 8: Nu supraproiectați.

Proiectați doar ceea ce este relevant acum. Puteți face codul suficient de generic pentru a sprijini dezvoltarea ulterioară, atâta timp cât nu devine prea complex. Nu creați clase parametrizate, fabrici, ierarhii profunde și interfețe ascunse pentru a rezolva probleme care nici măcar nu există – nu poți ghici ce se va întâmpla mâine. Pe de altă parte, atunci când structura codului nu se potrivește sarcinii, nu ezitați să-l refactorizați.

Regula 9: Fii consecvent.

Fă aceleași lucruri în același mod. Dacă dezvoltați o metodă a cărei funcționalitate este similară cu cea a uneia existente, utilizați un nume similar, o ordine similară a parametrilor și o structură similară a corpului. Același lucru este valabil și pentru clase. Creați câmpuri și metode similare, acordați-le interfețe similare și potriviți nume noi cu cele existente în clase similare.

Codul dumneavoastră trebuie să respecte convențiile cadrului dumneavoastră. De exemplu, este o bună practică să faceți gamele semideschise: închise (inclusiv) în stânga (la începutul intervalului) și deschise (exclusiv) în dreapta (la sfârșit). Dacă nu există acorduri pentru un anumit caz, atunci faceți o alegere și rămâneți la ea cu fanatic.

Regula 10: Evitați problemele de securitate.

Codul modern rareori funcționează izolat. Are un risc iminent de a deveni o țintă de atac. Nu trebuie să vină de pe Internet; atacul poate avea loc prin datele de intrare ale aplicației dvs. În funcție de limbajul și domeniul dvs. de programare, este posibil să aveți nevoie să vă faceți griji cu privire la depășirile de buffer-uri, scriptarea între site-uri, injecția SQL și alte probleme similare. Studiați aceste probleme și evitați-le în codul dvs. Nu e greu.

Regula 11: Utilizați structuri de date și algoritmi eficienți.

Codul simplu este adesea mai ușor de întreținut decât același cod, dar modificat pentru eficiență. Din fericire, puteți combina întreținerea și eficiența folosind structurile de date și algoritmii pe care cadrul dvs. vă oferă. Folosiți harta, setul, vectorul și algoritmii care funcționează cu ele. Acest lucru va face codul dvs. mai curat, mai rapid, mai scalabil și mai eficient în memorie. De exemplu, dacă stocați o mie de valori într-o mulțime sortată, operația de intersecție va găsi elemente comune cu un alt set în același număr de operații, mai degrabă decât un milion de comparații.

Regula 12. Utilizați teste unitare.

Complexitatea software-ului modern îl face mai costisitor de instalat și mai dificil de testat. O abordare productivă ar fi să însoțiți fiecare bucată de cod cu teste care verifică corectitudinea funcționării acestuia. Această abordare simplifică depanarea deoarece permite detectarea mai devreme a erorilor. Testarea unitară este necesară atunci când programați în limbaje tastate dinamic, cum ar fi Python și JavaScript, deoarece detectează erori numai în timpul rulării, în timp ce limbile cu tastare statică precum Java, C# și C++ pot prinde unele dintre ele în timpul compilării. Testarea unitară vă permite, de asemenea, să vă refactorizați codul cu încredere. Puteți utiliza XUnit pentru a facilita scrierea testelor și pentru a automatiza execuția acestora.

Regula 13: Păstrați codul portabil.

Cu excepția cazului în care aveți un motiv anume, nu utilizați funcționalitatea care este disponibilă numai pe o anumită platformă. Nu vă bazați pe anumite tipuri de date (cum ar fi numere întregi, indicatori și marcaje temporale) pentru a avea o anumită lungime (de exemplu, 32 de biți), deoarece acest parametru diferă pe platforme diferite. Păstrați mesajele programului separat de cod și nu codificați parametrii specifici culturii (cum ar fi separatorii zecimali sau formatele de dată). Sunt necesare convenții pentru ca codul să poată rula tari diferite, deci faceți localizarea cât mai nedureroasă posibil.

Regula 14: Fă-ți codul compus.

O comandă simplă ar trebui să vă asamblate codul într-o formă pregătită pentru distribuție. Comanda ar trebui să vă permită să construiți și să rulați rapid testele necesare. Pentru a atinge acest obiectiv, utilizați instrumente automate de construcție precum Make, Apache Maven sau Ant. În mod ideal, ar trebui să instalați un sistem de integrare care vă va verifica, construi și testa codul ori de câte ori se schimbă.

Regula 15: Pune totul în controlul versiunilor.

Toate elementele dvs. - cod, documentație, surse de instrumente, scripturi de construcție, date de testare - ar trebui să fie în controlul versiunii. Git și GitHub fac această sarcină ieftină și fără probleme. Dar multe altele vă sunt și la dispoziție instrumente puternice si servicii. Ar trebui să puteți construi și testa programul pe un sistem configurat pur și simplu descărcându-l din depozit.

Concluzie.

Făcând aceste 15 reguli parte din practica dumneavoastră zilnică, veți ajunge să creați un cod care este mai ușor de citit, care este bine testat, care are mai multe șanse să ruleze corect și care este mult mai ușor de schimbat când va veni momentul. De asemenea, te vei scuti pe tine și pe utilizatorii tăi de multe dureri de cap.