Inspringen & Regellengte

Je hoort vaak op het PHPhulp forum dat mensen iets meer gebruik moeten maken van de spatiebalk, omdat de geposte code anders niet te lezen is.
Eén van de meest belangrijke punten van netjes programmeren, betreft wel het inspringen; het maakt je code namelijk veel overzichtelijker en vergroot de leesbaarheid. En dat niet alleen voor anderen, maar ook voor jezelf, wanneer je na een jaar, een week of zelfs na een dag je code weer terugziet.

Bewijs zien?

Kijk eerst eens naar dit voorbeeld:

Waarschijnlijk duurde het bij de meeste mensen even om dit simpele voorbeeld te ontcijferen. Stel je voor dat dit voorbeeld honderd regels telde, of – nog erger – tientallen pagina’s code wat bij grote projecten vaak het geval zal zijn. Een beetje inspringen zou het al makkelijker moeten maken om in de code te duiken:



De PEAR codeerstandaard schrijft voor dat je met vier spaties per keer inspringt, en niet met tabs (ik vermoed dat platte tekst dat niet aankan?).
Sommige editors kan je echter zo instellen dat een tab gelijk komt te staan aan vier spaties.
In Emacs schijn je dat zo te kunnen doen:

(defun php-mode-hook ()
(setq tab-width 4
c-basic-offset 4
c-hanging-comment-ender-p nil
indent-tabs-mode
(not
(and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
(string-match "\.php$" (buffer-file-name))))))

En in Vim zo:

set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

Ik heb zelf echter géén ervaring met beide editors, dus ik kan je niet vertellen of dat bovenstaande klopt. Mocht er iemand zijn die wel een dergelijke editor gebruikt, dan hoor ik dat graag.

Het wordt bovendien aangeraden door PEAR om regels code na circa 75-85 karakters af te breken. Dit is echter geen standaard regelgeving en ’t is daarom min of meer aan jezelf om te bepalen hoe je code het meest overzichtelijk blijft.

« Lees de omschrijving en reacties