Delphi kodestil

Man ser tit at Delphi-programmører sjusker med koden. Det er på en måde klart nok, fordi Delphi ikke tager højde for, om man skriver ordene med stort eller lille, hvis de bare er stavet rigtigt. Men det kan være et problem at koden er sjusket, for det kan virke ulæseligt - for nogle mere end andre. Selv foretrækker jeg at koden er korrekt skrevet med store og små bogstaver på de steder, hvor det er rigtigt. Der er standarder for hvordan koden skal være stillet op, hvornår bogstaverne skal være med lille og med stort og hvilke bogstaver, man skal bruge foran komponentnavne. Vi skal nu se på nogle af de mest benyttede og derfor de vigtigste af slagsen.

For Delphis compiler kan det være ligegyldigt om man skriver på den her måde:

iF ((((tAL                      =  9))))        tHeN showMESSAGE('Tallet er 9');;;;;;;;;;;;;
;;;;;;;;;;;;;;;;

eller på denne:

if tal = 9 then
  ShowMessage('Tallet er 9');

Compileren bærer altså over med denne grimme syntaks, men der er selvfølgelig ingen, der ville skrive det sådan. Den, efter Delphis kodestandard, korrekte form er nummer 2. Ingen parantes i if-sætningen hvis ikke det er nødvendigt, alle reserverede ord med småt og en ny sætning med 2 mellemrum efter then og lignende. En anden vigtig ting, er at begin skal være på næste linje af en if, repeat eller while-sætning, altså:

if tal = 9 then
begin
  ShowMessage('Tallet er igen 9');
  // ...
end;

Man kan gøre det her, hvis man er i en else-sætning:

if tal = 9 then
begin
  // ...
end
else begin
  // ...
end;

Men den anden form er bedre og stemmer overens med kodestandarden.

I procedurer og funktioners navne skal et stort bogstav forekomme hver gang, der er et nyt ord:

function MinFunktion: string;

Der skal aldrig være mellemrum i paranteserne, og parametre skal sammenkobles så vidt som muligt:

procedure MinFunktion(Param1, Param2, Param3: string; Tal: Integer);

Klassers navne skal begynde med et stort T og for dem, og også for variabler, gælder de samme navngivnings-regler som ved procedurer og funktioner:

TMinKlasse = class(TMinAndenKlasse)

En anden ting, der gør koden lettere at redigere, hvis man ellers får vænnet sig til det, er hvis man har en bestemt måde at navngive sine komponenter på. Du kan selv vælge din metode, men det er smartest at følge den originale, da de fleste programmører vil følge den. Her følger en liste over nogle af de vigtigste komponentnavne og hvilke bogstaver, de skal starte med:

Standard	TButton	btn
	TCheckBox	chk
	TComboBox	cbo
	TEdit	edt
	TGroupBox	grp
	TLabel	lbl
	TListBox	lbo
	TMainMenu	mmnu
	TMemo	mem
	TMenuItem	mnu
	TPanel	pnl
	TPopupMenu	pmnu
	TRadioButton	rbtn
	TRadioGroup	rgrp
	TScrollBar	sbr
Additional	TBevel	bvl
	TBitBtn	bbtn
	TDrawGrid	dgrd
	THeader	hdr
	TImage	img
	TMaskEdit	medt
	TNotebook	nbk
	TOutline	oln
	TScrollBox	sbo
	TShape	shp
	TSpeedButton	sbtn
	TStringGrid	sgrd
	TTabbedNotebook	tbnbk
	TTabSet	tbs
Dialogs	TColorDialog	dlgcl
	TFindDialog	dlgfn
	TFontDialog	dlgft
	TOpenDialog	dlgop
	TPrintDialog	dlgpr
	TPrinterSetupDialog	dlgps
	TReplaceDialog	dlgrp
	TSaveDialog	dlgsv

Eksempler: btnOK, shpBold, sbtnSkriftType osv... Det er selvfølgelig mest vigtigst at følge disse navngivnings-regler ved store projekter, men det er rart, også for andre, at bruge dem ved alle ens Delphi programmer.

Brugen af kommentarer skal ikke overdrives. De mest nyttige kommentarer er dem, der forklarer hvorfor man gør netop det, man gør. Mange gange, hjælper det andre at forstå koden, men også dig selv, hvis du engang igen skal læse koden. Det er bedre end i stedet at forklare hvad der sker i koden. Hvis, der er en grund til det, kan du måske lave koden mere forståelig. Nogle gange er det dog bedst at forklare, hvad der sker i koden. Det kan være ved artikler og lignende, som netop har til formål at forklare, hvad der sker i koden. Det er derimod bedre at forklare koden i én blok under kodeblokken, man forklarer ud fra. Kommentarer kan også bruges til at notere noget undervejs i udviklings-processen. Det kan være at du vil komme tilbage til et stykke kode. Så kan du for eksempel skrive //-> eller noget andet, og når du så er færdig med koden, kan du bare slette disse kommentarer.

For en mere komplet Delphi kodestandard reference se: http://www.econos.de/delphi/cs.html