YLEISET:
- Muuttujien nimeäminen: englanniksi aloittaen pienellä kirjaimella, sanat eroteltuna alaviivalla.
Julistetaan kaikki muuttujat omilla riveillään funktioiden tms. alussa, aakkosjärjestyksessä.
Vakiot isoilla kirjaimilla, omassa lohkossaa ennen muita muuttujia. Kommenttirivi ennen muuttujaa,
muuttujan julistaminen seuraavalla rivillä,
ei tyhjiä rivejä väliin. Esim:
//yleinen varoitus
define("GENERAL_WARNING", 'Tekijät eivät vastaa ohjelman käytöstä koituvista tuhoista.');
//ryhmän nimi
define("GROUP_NAME", 'myva');
//Esimerkkimuuttuja, joka on tässä esimerkin vuoksi
var $alpha_variable;
//Toinen esimerkkimuuttuja, joka on aakkosissa ensimmäisen jälkeen
var $beta_variable = 'bee';
- Sisennykset: 2 välilyöntiä (ks. Eclipse asetukset -kohta alla).
- Pitkät rivit jaetaan usealle riville: html- ja css-koodissa rivi 72 merkkiä pitkä (ks. Eclipse asetukset.)
Muissa koodeissa harkinnan mukaan (tarvittaessa palataan aiheeseen).
- Kommentteja ei tarpeen säästellä; kirjoitetaan siten että joku toinenkin ne voisi ymmärtää, selvällä suomenkielellä.
Kommentteja ei koodirivien perään.
- Lohkot, sulkeet, välilyönnit ym. "Java-tyylisiä":
//funktiokutsu: ei välilyöntiä parametrien sulkeiden ja muuttujien väliin. Väli parametrien väliin.
//Väli ennen aaltosulkua. Tyhjä rivi nimen jälkeen. Välit operaattoreiden molemmilla puolilla. Tyhjä
// rivi loppuaaltosulkeen jälkeen, jos ei seuraavalla rivillä myös loppusulkua.
function jokuFunktio($a, $c) {
//koodit sisennettynä näin
$nimi = 'Matti';
}
//ehtolauseet: ei tyhjää riviä ehdon jälkeen. Aaltosulkeet kirjoitetaan aina (eli silloinki kun
//if:ssä vain yksi lause). Else kuten alla.
if ($a == $b) {
//...
} else {
//jotain muuta
}
//malleja muille ehtolauseille
while (ehto) {
//koodia
}
do {
//koodia
} while (ehto);
for (alkuarvo; ehto; askel;) {
//koodia
}
switch (muuttuja) {
case a:
//tapaus a
break;
case b:
//tapaus b
break;
}
PHP (http://www.phpbuilder.com/columns/tim20010101.php3 mukaan)
- Luokat, tiedostonimet: Caken mukaan.
- Kommentit: PHP:llä JavaDoccia vastaava työkalu nimeltään PhpDocumentor (www.phpdoc.org). Kirjatkaamme sen avulla seuraavat tiedot:
author, versio, selitys kustakin luokasta, selitykset metodeista, niiden parametreista ja paluuarvoista. Syntaksi menee näin:
- Included alkuun yhteen kohtaan. Include_once:ja ja muita *_once:ja ei käytetä.
- Kirjoitetaan php-tägit näin: . (Ei siis näin: ).
Esim. lyhyt php-lohko:
...
Hei
...
Esim. pitkä php-lohko:
...
...
- Merkkijonot: Käytetään muuten yksöissitaatteja, paitsi SQL-lauseissa kaksoissitaatteja.
Selityksen tynkää: Kaksoissitaatit parsitaan, yksöissitaatteja ei. Tästä johtuen yksöissitaattien
käyttö on tehokkaampaa, joten yksöissitaatteja tulisi käyttää pitkien tai useasti iteroitavien
merkkijonojen kanssa. SQL-lauseissa käytettäköön aina kaksoissitaattia, koska ne sisältävät
lainausmerkkejä ja muuttujia. Lähteessä vihjataan, että yksöissitaatteja käytettäisiin aina paitsi
SQL-lauseissa.
$nimi = 'Matti';
//ei-sql-lause:
$tervehdys2 = 'Terve (plaa plaa plaa) ' . $nimi . ' ja vielä (plaa plaa plaa plaa)';
//SQL-lause
$kysely = "SELECT jotain FROM taulu WHERE nimi = '$nimi'";
JAVASCRIPT (http://javascript.crockford.com/code.html mukaan "Java-tyylinen")
- Scriptit omissa tiedostoissa, ei html:n seassa. Kokemuksia / mielipiteitä?
- Scripti-tägi