Turinys

• Įvadas
  • Standarto svarba
  • Literatūra
• Vardai
  • Vardas turi tikti
  • Kalba
  • Santrumpos
  • Lokalūs kintamieji
  • Globalūs kintamieji
  • Aliasai
• Formavimas
  • Atitraukimas/Tarpai/Tab'ai
  • Eilutės ilgis
  • Operatoriai
  • Viena išraiška vienoje eilutėje

Įvadas

Standarto svarba

Kiekvienas individualus programuotojas dažniausiai rašo kodą taip, kaip jam atrodo teisingiausia ir įskaitomiausia. Tačiau kitam žmogui perskaityti kito visiškai kitokiu stiliumi parašytą kodą gali būti gana sudėtinga. Kadangi 100% nusistovėjusio standarto programavime nėra ir, tikriausiai, negali būti, aš siūlau vieną iš variantų.

Standartų pliusai

• Programuotojai gali pažiūrėti į bet kurią kodo vietą ir suprasti kas ten vyksta
• Nauji žmonės gali greičiau įsijungti į projektą
• Naujokams nebereikia išsiugdyti savo stiliaus ir ginti jo visą gyvenimą
• Naujokams nebereikia kartoti klaidų
• Žmonės daro mažiau klaidų pastovioje aplinkoje
• Programuotojai turi bendrą priešą :-)

Standartų minusai

• Standartai yra kvaili, nes paptastai sudaromi žmonių, kurie nieko nesupranta
• Standartai yra kvaili, nes yra ne tai ka aš darau
• Standartai sumažina kūribingumą
• Standartai nereikalingi, kol žmonės yra pastovūs
• Žmonės vistiek jų nesilaiko
• Standartai gali būti NIH (not invented here) priežastimi, nes naujas/pasiskolintas kodas nesusilies su naudojamu standartu

Literatūra

• Todd Hoff C++ Coding Standard

Vardai

Vardas turi tikti

Vardus stenkitės sudaryti, kad jie atspindėtų funkcijos, klasės, metodo, kintamojo paskirtį.

Kalba

Vardai (jei įmanoma) turėtų būti anglų kalba.

Argumentai

Anglų kalbą, tikriausiai, supranta visi programuotojai. Net jei kodas skaitomas tik ribotam kiekiui programuotojų, kurie tikrai supranta jūsų pasirinktą kalbą, vistiek rekomenduojama programavime vartoti anglų kalbą.

Santrumpos

Jei varde reikia naudoti santrumpą kaip HTML, URL, ir t.t. nerašykite jo viso didžiosimis raidėmis. Elkites su juo, kaip su paprastu žodžiu.

Argumentai

Dažniausiai sunkiau suprasti sutrumpinimą, kai jis yra visas didžiosiomis raidėmis (ypač jei po jo eina kitas žodis prasidedantis didžiąja)

Pavyzdys

Neteisingai:

    alias MyXVZ

Teisingai:

    alias MyXvz

Lokalūs kintamieji

• Tik mažosios raidės
• Žodziams atskirtu naudokite žemutinį brūkšnį ("_")

Argumentai

• Iš kintamojo vardo galima nusakyti jo scope

Pavyzdys

    alias do_it {
        var %foo_bar, %index
    }

Globalūs kintamieji

• Kintamojo vardas turi prasidėti raide "g"
• Kintamojo vardo kiekvienas žodis turi prasidėti didžiąja raide
• "g" raidė turi būti visada prieš "p" ar "r"

Argumentai

• Iš kintamojo vardo galima nusakyti jo scope

Pavyzdys

    set %gErrorNumber;

Aliasai

• Tik mažosios raidės
• Žodziams atskirtu naudokite žemutinį brūkšnį ("_")

Argumentai

• Taip aliasų vardai tampa išskirtiniai tarp kitų vardų

Pavyzdys

    alias my_alias {
    }

Formavimas

Atitraukimas/Tarpai/Tab'ai

• Naudokite 2 tarpus atitraukimui
• Atitraukite tiek kartų kiek reikia, bet ne daugiau. 4 ar 5 lygių paprastai turėtų užtekti. Jei reikia daugiau tikriausiai verta perorganizuoti kodą

Argumentai

• toks atitaukimas yra automatiškai formuojamas mIRC'o

Pavyzdys

    alias my_alias {
        if (something bad) {
            if (another thing bad) {
                while (more input) {
                }
            }
        }
    }

Eilutės ilgis

• Visada kada įmanoma eilutė neturėtų būti ilgesnė nei 80 simbolių

Argumentai

• Kodą daug lengviau skaityti, kai nereikia slankioti (scroll'inti)
• Nors beveik kiekvienas dabar turi palyginti didelį monitorių, bet platesnių langų mažiau telpa ekrane, o daugiau langų yra geriau už platesnius langus

Operatoriai

• Visada iš abiejų pusių palikite po tarpą aplink visus lyginimo, priskyrimo ir matematinius (=, ==, !=, <, >,+, -, *, /, etc.) operatorius
• Prieš kablelį atskiriantį aliaso parametrus neturi būti tarpo
• Po kablelio atskiriančio aliaso parametrus turi būti tarpas
• Nenaudokite kablelio keliems kintamiesiems aprašyti. Aprašykite kiekvieną atskiroje eilutėje

Viena išraiška vienoje eilutėje

Visada rašykite tik vieną išraišką veinoje eilutėje, nebent išraiškos yra viena su kita labai atrimai susijusios. pastaruoju atvėju nepaminrškite padeti papildomą tarpą.

Taip pat visada aprašykite tik vieną kintamajį vienoje eilutėje.