Frekvenskod i programmeringsspråk. Programkod

För att programmet ska kunna utföra de åtgärder som föreskrivs för det, till exempel beräkna, visa resultatet, reagera på användaråtgärder, till exempel för att trycka på knappar, markera rader från en lista, det är nödvändigt programkod.

Programkod är en uppsättning ord och symboler i ett programmeringsspråk.

Alfabet är en komplett uppsättning bokstäver, siffror och symboler som används på språket för att beteckna data och åtgärder på dem.

Visual Basic -alfabetet innehåller följande teckenuppsättning:

Versaler (A - Z) och gemener (a - z) i det latinska alfabetet;

Tal från 0 till 9;

Aritmetiska tecken (i stigande prioritetsordning): +, -, *, /, |, ^;

Relationsoperationstecken: =,<, >.

Skiljetecken och separatorer :,  . : ; ();

Språkets alfabet innehåller också reserverad ord som inte kan användas som namn variabler eller procedurer. Exempel på reserverade ord: Dim, Sub, Integer, etc. Som standard används ett blått teckensnitt för att markera sökord i fönstret Visual Basic Code Editing.

Ord och symboler bör skrivas strikt enligt språkreglerna, utan stav- och skiljetecken. Det är den exakta stavningen som gör att datorn otvetydigt kan förstå och köra programmet.

Kodfönster

Programkoden skrivs i kodfönstret. Varje formulär har ett sådant fönster.

Öppna kodfönster:

1 sätt - i fönstret Project Explorer högerklicka på önskat formulär och välj Visa kod.

Notera: kodfönstret kanske är kopplat till formuläret. Ett separat kodfönster kallas Modul... Moduler i fönstret Projektutforskare grupperas i en grupp Moduler... För att öppna ett fönster med modulkoden behöver du i fönstret Projektutforskare dubbelklicka på modulnamnet.

2 sätt - dubbelklicka på en kontroll i formuläret eller på själva formuläret i formulärfönstret.

Notera: detta öppnar inte bara kodfönstret, utan skapar också en händelsehanteringsprocedur (se nedan).

Kodfönsterstruktur:

Ris. 7. Fönster för programkoden.

    Lista över kontroller

    Lista över kontrollhändelser

    Förfarande (kod)

Förfaranden

Eftersom när kylskåpet öppnas tänds lampan, och när kranen öppnas rinner det ut vatten, vi kan säga att när kylöppningshändelsen inträffar utförs en procedur och ventilöppningshändelsen utlöser ett annat förfarande. På samma sätt består programkoden av separata procedurer, som var och en utför sina egna specifika åtgärder för det, till exempel tänder en procedur en lampa, den andra tänder (pumpar) vatten.

Visual Basic - procedurprogrammeringsspråk. Detta innebär att du kan skapa kodblock i den, som sedan kan refereras till med namn. När kodblocket har fått namnet kan det vara det tillkallade och avrättade. Det är som ett program inom ett program. Små program som "lever" i stora program kallas fungerar om de ger tillbaka något värde, och underrutiner, om de inte returnerar värden.

Subrutiner och funktioner gör programmeringen enklare och snabbare och den genererade koden mer tillförlitlig. Att skapa egna rutiner och funktioner är det första steget i utvecklingen inkapslad och återanvändbar kod. Inkapsling innebär att dölja implementeringen av egenskaper och metoder för ett objekt bakom dess externa gränssnitt.

Procedur (subroutine) är en separat bit av programkod som vanligtvis löser ett litet problem; det är ett logiskt konstruerat, litet programblock som hela programmet är uppdelat i.

Om ett förfarande bara kan utföras inom ett givet programblock (till exempel bara i detta formulär), och det inte kan anropas från ett annat programblock, är ett sådant förfarande lokalt. Den lokala proceduren anges med nyckelordet Private Sub.

Om proceduren kan anropas från andra programblock (till exempel från ett annat formulär), är en sådan procedur global. Den globala proceduren anges med nyckelordet Public Sub.

Som standard, om det inte finns något nyckelord före Sub -nyckelordet, är detta ett globalt förfarande.

Förfarandena är:

    Evenemangsprocedurer... Körs när en händelse inträffar i någon kontroll (eller form). Ett händelseförfarande är alltid associerat med ett objekt. För att kalla händelseproceduren för ett objekt, räcker det med att dubbelklicka på detta objekt.

    Godtyckliga förfaranden... De är inte händelserelaterade och kan kallas från någon annan procedur och köras när som helst. Om samma programblock förekommer i ett program i alla former, kan det bara skrivas en gång och på ett ställe, i form av ett globalt gemensamt program. Lanseringen av ett vanligt program är inte associerat med ett objekt eller en händelse, utan sker när det nås från andra programblock. Anropa ett allmänt förfarande från samma formulär: ProcedureName (ParameterList)... Anropa ett vanligt förfarande från ett annat formulär: ETT OBJEKT. ProcedureName (ParameterList)... Den allmänna proceduren är både lokal privat och global allmänhet.

Procedurstruktur

Förfarandet består av följande delar:

    Procedurhuvud - markerar början på proceduren, dess typ, syfte (händelse).

Ett exempel på rubriken för en procedur som körs när du klickar på knappen Command1.

    Ord Privat betyder - stängt, det vill säga proceduren tillhör endast denna blankett eller modul och kan inte användas av andra behållare (formulär, moduler). Om detta ord utelämnas kommer proceduren att vara öppen för andra behållare.

    Sub- procedur.

Notera: förutom procedurer finns funktioner - funktion. Funktioner är inte kopplade till händelser och kan dessutom returnera resultatet av deras arbete (beräkningar).

    Kontrollelement(eller formulärnamn): detta är det exakta namnet på elementet som lagras i egenskapen Namn.

    Händelse- namnet på evenemanget. Här är några av händelserna:

    Klicka - musklick;

    DblClick - dubbel musklick;

    KeyPress - knapptryckning;

    UnLoad - lossning av formuläret (när formuläret är stängt slutar programmet);

    Aktivera - aktivera formuläret (när du klickar på formuläret, när dess titel är markerad);

    Inaktivera - inaktivera formuläret (när du klickar på ett annat formulär).

    Initiera - när du skapar ett objekt av typform.

    Ändra storlek - när du ändrar storlek på formuläret

    Avsluta - när du tar bort formuläret

    Argumentär den första informationen som skickas till förfarandet för behandling.

Godtyckliga förfaranden har följande rubrik:

Procedurens namn borde vara unikt, måste börja med en bokstav och får inte innehålla mellanslag eller andra tecken än understrykningen. Proceduren kallas vid namn när den behöver köras.

    Slut på proceduren - avslutar programkoden för proceduren: Avsluta Sub

Notera: för funktioner: Avsluta funktion

    Kroppsförfarande är gränserna mellan titeln och slutet. Deras antal är obegränsat. Raderna innehåller instruktioner som måste köras när proceduren anropas (en händelse inträffar).

Subrutin (Sub) - är ett förfarande som kör programkod inom sitt block och inte returnerar ett värde. Syntaxen för en enkel underprogram är:

( Privat | offentlig ) Sub SubMain ()

.. kodrader Slutet Sub

Delrutins omfattning;

Subtyp av procedur (nämligen en subrutin);

underhuvud namnet som tilldelats underrutinen;

End Sub - slutet på subrutinkodblocket.

Skapa procedur

Gör följande för att skapa ett förfarande:

    1 sätt - dubbelklicka på önskad kontroll eller formulär. Kodfönstret öppnas och titeln och slutet på proceduren visas i det. Om en annan händelse behövs väljs den med hjälp av listan i det övre högra hörnet av kodfönstret.

    2 sätt - öppna kodfönstret, kör Verktyg → Lägg till procedur → ange namn och parametrar för proceduren → Ok.

    3 sätt - öppna kodfönstret och ange de önskade raderna från tangentbordet.

Resultatet ska vara:

Privat underkommando1_Click ()

Samtalsprocedurer för utförande

    Denna händelse måste ha inträffat för att händelseförfarandet ska kunna köras.

    För att utföra ett godtyckligt förfarande anges namnet på det här förfarandet i en annan procedur.

Privat underkommando1_Click ()

Här ökar klickhändelsen genom att trycka på Command1 -knappen och aktiverar och utför Kvadrat -proceduren.

Förfarandekoden körs rad för rad och uppifrån och ner.

Funktionen (Fungera) - det är ett förfarande som kör rader i koden och returnerar ett visst värde. Syntaxen för en enkel funktion är följande:

Fungera FunctionName () Som datatyp

... strängarkoda

FunctionName = ReturnValueAvsluta funktion

Funktionsomfång;

Funktion är ett Visual Basic -nyckelord som anger att detta är en funktion;

FunctionName () - namnet som tilldelats funktionen;

AS är ett Visual Basic -nyckelord som föregår tilldelning av en datatyp;

Data typ datatypen för returvärdet;

Returvärde värdet som ska tilldelas funktionsnamnet (detta är en mycket viktig punkt!);

Slutfunktion - slutet på detta kodblock.

Behovet av att ha en egen webbplats idag upplevs av många företag, såväl som individer, därför är information om utveckling och marknadsföring av internetprojekt så efterfrågad. Många människor är intresserade av frågan - hur man självständigt skapar webbplats, programkod för vilken är en sken av en grund för ett hus? Låt oss försöka förstå denna fråga och fördjupa oss i ämnet webbutveckling.

En webbplats är inte bara en samling text, länkar, bilder och färgglada banners, det är också en programkod som körs på användarens dator eller på serversidan. Och om idag nästan alla kan skapa bilder i önskat format i önskad upplösning och kvalitet, med hjälp av färdiga bilder från Internet eller någon populär grafisk redigerare, skapa sedan webbplatskod för en lekman har stora svårigheter.

Kvaliteten på applikationer och Internetprojektet som helhet beror starkt på skickligheten hos programmeraren som utvecklar webbplatsen, vars programkod kan innehålla fel som i hög grad påverkar hastigheten på att ladda webbsidor och många andra aspekter av hela webbplatsen, inklusive de som rör säkerhet. Därför är det nödvändigt att upptäcka och eliminera fel i koden när du skapar en webbplats. Det är bäst att anförtro utvecklingen av en komplex företagswebbplats till specialister (om du inte är det), eftersom vissa fel är svåra att upptäcka, och många av dem kan ytterligare leda till långsammare inläsning och felaktig visning av webbsidor i webbläsarna i datorer för Internetanvändare. För lång laddning kan leda till ett antal besökare från webbplatsen och en minskning av trafikkvaliteten, vilket minskar vinsten och effektiviteten från användningen av kommersiella internetprojekt.

HTML och CSS först

Grunden för ett webbdokument är kod skriven på HTML -markeringsspråket. Markeringsspråket ska inte förväxlas med programmeringsspråket, men exakt vad som är skillnaden skrivs i detalj. I grund och botten kan du med hjälp av en uppsättning kommandon som erbjuder en HTML -webbplatsutvecklare ställa in alla nödvändiga parametrar för ett statiskt webbdokument - layouten av element (blocklayout), rubriker, stycken, tabeller, bilder etc. Och med hjälp av CSS, ett speciellt tillägg för HTML, kan du placera alla listade markeringsobjekt, ändra deras stil - färg, storlek, format etc.

Därefter JavaScript

Interaktiva och animerade element, till exempel - banners, krypande linje, feedbackformulär, arbete på webbsidor på grund av förekomst av skript och kod skriven på server- eller klientprogrammeringsspråk. Skript som utvecklats med programmeringsspråket JavaScript är mycket populära. Sådana klientskript i sitt arbete använder inte serverns funktioner och körs på sidan av användarens dator, det vill säga i webbläsaren. Detta gör JavaScript -applikationer enkla och snabba.

Äntligen PHP

I de fall då det är nödvändigt att skriva komplexa och omfattande koder, till exempel för forum eller gästböcker, vänder sig programmerare till programmeringsspråk på serversidan för att få hjälp, och i synnerhet till. PHP -koder körs på serversidan, så deras arbete kan bli något långsammare, eftersom det beror på hastigheten på anslutningen till fjärrdatorn och graden av dess arbetsbelastning. Med hjälp av PHP- och SQL -kommandon (ett speciellt språk för att fråga efter en relationsdatabas) kan du organisera interaktionen mellan en webbplats och databaser och skapa interaktiva internetprojekt - forum, onlinebutiker, anslagstavlor, olika kataloger etc.

Oroa dig inte för mycket om vilket språk du ska välja att studera. Många nybörjare har svårt att välja språk när de precis börjar lära sig hur man skriver programkoder. Det egentliga språket du väljer spelar ingen roll när det gäller att studera strukturer och logik för att bygga information. Dessa färdigheter är mycket viktigare och kan läras med alla programmeringsspråk.

  • När du väljer ett språk, koncentrera dig på det syfte som du vill skapa programkoder för och välj först startspråket. Om du till exempel vill göra webbplatsutveckling bör du börja med att lära dig HTML och sedan komplettera det med CSS, JavaScript och PHP. Om du vill skapa program för datorer, börja sedan lära dig C ++ eller något annat vanligt programmeringsspråk.
  • Om du blir en professionell programmerare kommer du snabbt att inse att du aldrig kommer att använda det språk du ursprungligen lärde dig för ditt arbete. Istället kommer du att fortsätta att lära dig nya språk hela tiden genom dokumentation och experiment.

Hitta gratis onlineresurser som är dedikerade till ditt valda språk. Internet är en skattkista med gratis handledning, kurser och videor om det språk du väljer att lära dig. Du kan lära dig grunderna i nästan alla inledande språk på en dag.

  • Här är bara några populära webbplatser: Bento, CodeAcademy, Code.org, html.net, Khan Academy, Udacity, W3Schools och många fler.
  • Det finns också en mängd olika startguider för olika språk på wikiHow.
  • Du kan hitta självstudievideor för nästan alla språk på YouTube.
  • Stack Exchange är ett av de mest populära forum där professionella programmerare svarar på frågor från användare.
  • Ladda ner en bra textredigerare. Många programmeringsspråk gör det möjligt att använda externa textredigerare för att skriva program. Hitta en textredigerare som visar indragning och kodmarkering.

    • Populära program inkluderar Notepad ++ (Windows), TextWrangler (OS X) och JEdit (vilket system som helst).
  • Ladda ner alla kompilatorer du behöver. Vissa programmeringsspråk kräver att en kompilator visar källkoden som du skrev. Kompilatorer översätter källkoden till ett motsvarande språk på låg nivå, som sedan bearbetas av datorn. Många kompilatorer är öppen källkod och gratis programvara. Språk som kräver användning av kompilatorer inkluderar:

    • GRUNDLÄGGANDE
    • Fortran
    • Pascal
  • Starta ditt första projekt. Välj ett bra introduktionsprojekt som låter dig testa dina nya färdigheter. Det finns många förslag och handledning om detta ämne på Internet; till exempel kan du börja med att skapa enkla webbplatser med HTML, enkla databaser och funktioner med PHP, eller enkla program på något av de språk som kräver användning av kompilatorer.

    Utnämning

    Källkoden används antingen för att producera objektkod eller körs av tolken. Ändringar görs aldrig i objektkoden, bara i den ursprungliga, följt av omkonvertering till objektkod.

    Ett annat viktigt syfte med källkoden är som en beskrivning av ett program. Med hjälp av programmets text kan du återställa logiken för dess beteende. Kommentarer används för att göra källkoden lättare att förstå. Det finns också verktyg som låter dig automatiskt hämta dokumentation från din källkod-den sk. dokumentationsgeneratorer.

    Dessutom har källkoden många andra användningsområden. Det kan användas som ett undervisningsverktyg; Nybörjare kan tycka att det är bra att undersöka befintlig källkod för att lära sig programmeringstekniker och metoder. Det används också som ett kommunikationsverktyg mellan erfarna programmerare på grund av dess korta och entydiga karaktär. Koddelning bland utvecklare nämns ofta som en bidragande faktor för att förbättra programmeringsupplevelsen.

    Programmerare överför ofta källkoden (som moduler, som den är eller med anpassning) från ett projekt till ett annat, som kallas återanvändning av kod.

    Källkoden är en viktig komponent för att överföra programvara till andra plattformar. Utan källkod för någon programvara är portning antingen för svårt eller omöjligt.

    Organisation

    Källkoden för någon del av programvaran (modul, komponent) kan bestå av en eller flera filer. Programkod är inte nödvändigtvis skriven på bara ett programmeringsspråk. Exempelvis innehåller C -program ofta samlingsspråkinsatser för optimeringsändamål. Det är också möjligt att vissa komponenter eller delar av ett program är skrivna på olika språk och sedan samlas i en enda körbar modul med hjälp av en teknik som kallas länka bibliotek ( bibliotekslänkning).

    Komplicerad programvara kräver dussintals eller till och med hundratals källfiler för att bygga. I sådana fall används vanligtvis projektfiler för att förenkla bygget, som beskriver beroenden mellan filerna med källkoden och beskriver byggprocessen. Dessa filer kan också innehålla alternativ för kompilatorn och designmiljön. För olika designmiljöer kan olika projektfiler användas, och i vissa miljöer kan dessa filer vara i ett textformat som är lämpligt för direktredigering av en programmerare som använder universella textredigerare, i andra miljöer stöds speciella format och filer skapas och modifieras med hjälp av speciella instrumentprogram. Projektfiler kallas vanligtvis källkod. I de allra flesta moderna språkmiljöer används projektfiler nödvändigtvis, oavsett komplexiteten hos den andra källkoden som ingår i projektet. Ofta betyder källkod också resursfiler som innehåller olika data, till exempel grafik som behövs för att bygga ett program.

    För att underlätta arbetet med källkoden, för gemensamt arbete med koden av ett team av programmerare, används versionskontrollsystem.

    Kvalitet

    Till skillnad från människor finns det ingen "välskriven" eller "dåligt skriven" kod för en dator. Men hur koden skrivs kan ha en djupgående effekt på underhållsprocessen. Källkodens kvalitet kan bedömas utifrån följande parametrar:

    • kodens läsbarhet (inklusive förekomsten av kommentarer till koden);
    • enkel support, testning, felsökning och buggfixning, modifiering och portning;
    • ekonomisk resursanvändning - minne, processor, diskutrymme;
    • inga kommentarer visas av kompilatorn;
    • frånvaro av "skräp" - oanvända variabler, oåtkomliga kodblock, onödiga föråldrade kommentarer, etc .;
    • adekvat felhantering;
    • portabilitet - möjligheten att använda en hanterare (kompilator, tolk, översättare) av olika versioner eller till och med olika operativsystem;
    • möjligheten att internationalisera gränssnittet.

    Icke-körbar källkod

    Copyleft -licenser för fri programvara kräver distribution av källkod. Dessa licenser används också ofta för icke-programvaruarbete, såsom dokumentation, bilder, datafiler för datorspel.

    I sådana fall anses källkoden vara den föredragna formen av verket för redigering. Det kan också kallas "transparent" version i licenser för annan än programvara. Detta kan till exempel vara:

    • för en fil komprimerad med dataförlust - förlustfri version;
    • för återgivning av en vektorbild eller en tredimensionell modell - vektorversionen respektive modellen;
    • för textbilder - samma text i textformat;
    • för musik - en fil i musikredigerarens interna format;
    • och slutligen själva filen, om den uppfyller de angivna villkoren, eller om en mer bekväm version helt enkelt inte fanns.

    se även


    Wikimedia Foundation. 2010.

    Se vad "källkod" finns i andra ordböcker:

      Filmens originalmaterial är negativt, mottyp, en kontrollkopia av filmen, originalet av magnetiska ljudspår, återinspelning av musik, ljud, mastervideoljudspår, CD, etc. Synonymer: texten exekveras antingen direkt av tolken, eller ... ... Ekonomiskt ordförråd

      Mänskligt skriven text av ett datorprogram i valfritt programmeringsspråk Ordbok för affärsvillkor. Academic.ru. 2001 ... Verksamhetsordlista

      källa- - Ämnen telekommunikation, grundläggande begrepp SV källkod ... Teknisk översättarguide

      källa-3.1.13 källkod: Ett datorprogram uttryckt i en läsbar form (programmeringsspråk) som översätts till maskinläsbar form (objektkod) innan det kan testas med ... ... Ordbok-referensbok med termer av normativ och teknisk dokumentation

      källa- språket i källtexten ... Förklarande översättningsordbok

      Källkod: Källkoden för en skriven text från ett datorprogram. Källkoden för technotriller regisserad av Duncan Jones ... Wikipedia

      Denna term har andra betydelser, se källkoden. Källkod ... Wikipedia

      Denna artikel saknar länkar till informationskällor. Informationen måste vara verifierbar, annars kan den ifrågasättas och raderas. Du kan ... Wikipedia

      Open Source Initiative (OSI) -logotyp Öppen källkodsprogramvara är programvara med öppen källkod. Källkoden för de skapade programmen är öppen, det vill säga den är tillgänglig för visning och ändring. Detta är ... ... Wikipedia

      Källprogram (källkod)- 48) ett källprogram (källkod) en motsvarande representation av en eller flera processer som kan omvandlas av ett programmeringssystem till en form som kan exekveras av utrustning (objektkod eller objektspråk) (kategorier 6, 7 och 9) ; ... Officiell terminologi

    15 regler för att skriva kvalitetskod

    Det finns otaliga sätt att skriva dålig kod. Lyckligtvis räcker det med 15 regler för att stiga till kvalitetskodsnivån. Efterlevnad av dem kommer inte att göra dig till en mästare, men låter dig övertygande efterlikna honom.

    Regel 1. Följ kodningsstandarder.

    Varje programmeringsspråk har sin egen kodningsstandard, som berättar hur man indrag, var man ska placera mellanslag och parenteser, hur man heter objekt, hur man kommenterar koden etc.

    Till exempel, i denna kod, enligt standarden, finns det 12 fel:

    För (i = 0; i

    Studera standarden noggrant, lär dig grunderna utantill, följ reglerna som bud, och dina program kommer att bli bättre än de flesta forskarutbildningar.

    Många organisationer anpassar standarder för att passa deras specifika behov. Till exempel har Google utvecklat standarder för mer än 12 programmeringsspråk. De är genomtänkta, så kolla in dem om du behöver hjälp med att programmera för Google. Standarderna inkluderar till och med redigerarinställningar som hjälper dig att följa en stil och specialverktyg för att verifiera att din kod matchar den stilen. Använd dem.

    Regel 2. Ge beskrivande namn.

    Begränsad av långsamma, klumpiga teleprinters, använde programmerare i forntiden kontrakt för variabel- och procedurnamn för att spara tid, nyckelknackningar, bläck och papper. Denna kultur finns i vissa samhällen för att upprätthålla bakåtkompatibilitet. Ta till exempel den språkbrytande C-funktionen wcscspn (bred teckensträng komplement span). Men detta tillvägagångssätt är inte tillämpligt i modern kod.

    Använd långa beskrivande namn som complementSpanLength för att hjälpa dig och dina kollegor att förstå din kod i framtiden. Undantagen är några viktiga variabler som används i en metod, såsom loop -iteratorer, parametrar, tillfälliga värden eller körresultat.

    Det är mycket viktigare att du tänker länge och väl innan du namnger något. Är namnet korrekt? Menade du högsta pris eller bästa pris? Är namnet tillräckligt specifikt för att undvika att använda det i andra sammanhang för liknande objekt? Skulle det inte vara bättre att namnge metoden getBestPrice istället för getBest? Passar den bättre än andra liknande namn? Om du har en ReadEventLog -metod bör du inte ringa en annan NetErrorLogRead. Om du namnger en funktion, beskriver namnet returvärdet?

    Slutligen några enkla namnkonventioner. Klass- och typnamn måste vara substantiv. Metodnamnet måste innehålla ett verb. Om en metod avgör om viss information om ett objekt är sann eller falsk, måste dess namn börja med "är". Metoder som returnerar egenskaper för objekt måste börja med "get", och de som anger fastighetsvärden måste börja med "set".

    Regel 3. Kommentera och dokumentera.

    Börja varje metod och procedur med att kommentera vad metoden eller proceduren gör, parametrarna, returvärdet och eventuella fel och undantag. Beskriv i kommentarerna rollen för varje fil och klass, innehållet i varje klassfält och huvudstegen i komplex kod. Skriv kommentarer när du utvecklar din kod. Om du tror att du kommer att skriva dem senare lurar du dig själv.

    Se också till att det finns en manual för din applikation eller ditt bibliotek som förklarar vad din kod gör, definierar dess beroenden och ger instruktioner för att bygga, testa, installera och använda. Dokumentet ska vara kort och bekvämt. en enkel README -fil är ofta tillräcklig.

    Regel 4. Upprepa dig inte.

    Kopiera eller klistra aldrig in koden. Extrahera istället den gemensamma delen till en metod eller klass (eller ett makro om det behövs) och använd den med lämpliga parametrar. Undvik att använda liknande data och kodbitar. Använd också följande tekniker:

    • Skapa API -referenser från kommentarer med Javadoc och Doxygen.
    • Automatisk generering av enhetstester baserade på kommentarer eller namngivningskonventioner.
    • Generera PDF och HTML från en enda taggad källa.
    • Hämta klassstrukturen från databasen (eller vice versa).

    Regel 5. Kontrollera om det finns fel och reagera på dem.

    Metoder kan returnera fel tecken eller kasta undantag. Behandla dem. Lita inte på att disken aldrig kommer att fyllas, konfigurationsfilen kommer alltid att vara på plats, din applikation körs med alla nödvändiga behörigheter, minnesallokeringsförfrågningar kommer alltid att lyckas eller att anslutningen aldrig kommer att upphöra. Ja, bra felhantering är svårt att skriva och gör koden längre och svårare att läsa. Men att ignorera fel sveper helt enkelt problemet under mattan, där en intet ont anande användare en dag kommer att upptäcka det.

    Regel 6. Dela upp din kod i korta, separata delar.

    Varje metod, funktion eller kodblock måste passa in i ett normalt skärmfönster (25-50 rader). Om det är längre, dela i kortare bitar. Även inuti metoden, dela lång kod i block, vars essens du kan beskriva i kommentarerna i början av varje block.

    Dessutom måste varje klass, modul, fil eller process utföra en viss typ av uppgift. Om en kodbit utför helt olika uppgifter, dela den sedan.

    Regel 7. Använd API-ramverk och tredjepartsbibliotek.

    Utforska vilka funktioner som är tillgängliga via API: et för ditt ramverk. och även vad avancerade tredjepartsbibliotek kan göra. Om bibliotek stöds av din systempakethanterare är det troligtvis ett bra val. Använd kod för att hindra dig från att återuppfinna hjulet (och den värdelösa fyrkantiga formen).

    Regel 8. Överdriv inte designen.

    Designa bara det som är relevant nu. Du kan göra din kod ganska generisk för att stödja vidare utveckling, men bara om den inte gör den för komplex. Skapa inte parametrerade klasser, fabriker, djupa hierarkier och dolda gränssnitt för att lösa problem som inte ens finns - du kan inte gissa vad som händer i morgon. Å andra sidan, när kodens struktur inte passar uppgiften, kan du återskapa den.

    Regel 9. Var konsekvent.

    Gör samma saker på samma sätt. Om du utvecklar en metod vars funktionalitet liknar funktionaliteten hos en befintlig, använd sedan ett liknande namn, en liknande ordning av parametrar och en liknande kroppsstruktur. Detsamma gäller för klasser. Skapa liknande fält och metoder, gör dem till liknande gränssnitt och mappa nya namn till befintliga namn i liknande klasser.

    Din kod måste följa konventionerna i din ram. Till exempel är det bra att göra områden halvöppna: stängda (inklusive) till vänster (i början av intervallet) och öppna (exklusiva) till höger (i slutet). Om det inte finns någon överenskommelse för ett visst fall, gör ett val och håll dig till det fanatiskt.

    Regel 10. Undvik säkerhetsproblem.

    Modern kod fungerar sällan isolerat. Han löper den oundvikliga risken att bli utsatt för attacker. De behöver inte komma från internet; attacken kan ske genom inmatning av din applikation. Beroende på ditt programmeringsspråk och din domän kanske du vill oroa dig för buffertöverflöd, skript över flera platser, SQL-injektion och liknande problem. Studera dessa problem och undvik dem i din kod. Detta är inte svårt.

    Regel 11. Använd effektiva datastrukturer och algoritmer.

    Enkel kod är ofta lättare att underhålla än en som ändras för effektivitet. Lyckligtvis kan du balansera underhållbarhet och effektivitet genom att utnyttja datastrukturer och algoritmer som ditt ramverk tillhandahåller. Använd karta, uppsättning, vektor och algoritmer som fungerar med dem. Detta gör din kod renare, snabbare, mer skalbar och mer minneseffektiv. Om du till exempel lagrar tusen värden i en sorterad uppsättning, kommer skärningsoperationen att hitta vanliga element med en annan uppsättning i samma antal operationer, snarare än en miljon jämförelser.

    Regel 12. Använd enhetstester.

    Komplexiteten hos modern programvara gör det dyrare att installera och svårare att testa. Ett produktivt tillvägagångssätt skulle vara att behålla varje kodbit med tester som verifierar att dess arbete är korrekt. Detta tillvägagångssätt gör felsökning enklare eftersom det låter dig upptäcka fel tidigare. Enhetstestning är nödvändig när du programmerar på dynamiskt skrivna språk som Python och JavaScript eftersom de bara får några fel vid körning, medan statiskt skrivna språk som Java, C # och C ++ kan fånga några av dem på kompileringstid. Enhetstestning låter dig också återskapa din kod med tillförsikt. Du kan använda XUnit för att göra det enklare att skriva tester och automatisera dem att köra.

    Regel 13. Håll din kod bärbar.

    Om du inte har en specifik anledning ska du inte använda funktioner som bara är tillgängliga på en viss plattform. Lita inte på att vissa datatyper (som heltal, pekare och tidsstämplar) har en specifik längd (till exempel 32 bitar), eftersom denna parameter skiljer sig från olika plattformar. Håll programmeddelanden åtskilda från kod och inkludera inte kulturspecifika parametrar (till exempel fraktionerade och heltalsseparatorer eller datumformat). Konventionerna behövs för att koden ska kunna köras i olika länder, så gör lokaliseringen så smärtfri som möjligt.

    Regel 14. Gör din kod samlingsbar.

    Ett enkelt kommando bör sätta ihop din kod till ett distributionsklart formulär. Kommandot ska låta dig snabbt bygga och köra de tester du behöver. För att uppnå detta, använd automatiserade byggverktyg som Make, Apache Maven eller Ant. Helst bör du skapa ett integrationssystem som kontrollerar, bygger och testar din kod när du ändrar den.

    Regel 15. Placera allt i ett versionskontrollsystem.

    Alla dina element - kod, dokumentation, verktygskällor, byggskript, testdata - måste vara under versionskontroll. Git och GitHub gör denna uppgift billig och problemfri. Men det finns många andra kraftfulla verktyg och tjänster tillgängliga för dig också. Du bör kunna bygga och testa ditt program på ett konfigurerat system genom att helt enkelt ladda ner det från förvaret.

    Slutsats.

    Genom att göra dessa 15 regler till en del av din dagliga praxis kommer du att skapa kod som är lättare att läsa, är väl testad, är mer sannolikt att fungera korrekt och är mycket lättare att ändra när den tid kommer. Du kommer också att rädda dig själv och dina användare från mycket huvudvärk.

  • Dela detta