Hea skripti omadused

From EIK wiki

Mis on hea skript?

Autor

Kristjan Indlo A31

Ver 1: 2014-03-14

Sisu

Skripti pealkiri iseloomustab skripti lühidalt

Kommentaar skripti alguses, mida skript kokkuvõtlikult paari sõnaga teeb.

N: andmete korrastamise skript

Skripti alguses on autor, versioon ja muudatuste kuupäev

Nagu on ka heal dokumentatsioonil(meie puhul on ka rühmanumber)

Skript on korrektselt vormistatud

Ilus loetav kood, trepid, tegevused komenteeritud

Skripti alguses oleks kirjeldatud skripti eesmärk

Mida skript teeb?

Pärast seda tulevad alles alamapealkirjad(funktsioonid, väiksed skritptid/-skripti osad)

Skripti ülesehitus vastaks ülesandele

??Olenevalt ülesandest on käsud lahti- või kokku kirjutatud??

Hea skript kasutab keskkonnamuutujaid

N: $HOME $PATH $KALA

Skript on vajadusel tagasiühilduv

Skripti elemendid on loogiliselt järjestatud

Skript peab olema testitud ja töötama, veendumaks, et skript õgiesti toimib.

Dont repeat yourself

Failinime kordudes luuakse muutuja

UNIX ideoloogia

Skript täidab ülesande võimalikult lihtsalt ja vähese ressursikasutusega.

Skript ei tohi teha üleliigset.

Veateated

Veateated peavad minema veavoogu

N:cron saadab vea süsteemiadministraatorile.

Skriptitav skript

Hea skript on ise skriptitav- teised skriptid saavad eelmainitut välja kutsuda

Vea töötlus

Veakoodi tagastamine -exit 0 edukas, vigu ei olnud.

Exit muu numbriga tähendab viga.