Zaujímavá skúsenosť so skracovaním zdrojových textov

Zápisník experimentátora

Hierarchy: Vývoj stránky

Dnes sa mi stala zaujímavá príhoda. Napísal mi jeden z čitateľov, že mu nejde skompilovať zverejnený kód. Po chvíli sme sa dopátrali k tomu, že si skopíroval zdrojový text priamo zo stránky, kde som ho uverejnil v skrátenej podobe. A pretože v texte bolo veľa pôvodného zdrojáku vynechaného, pochopiteľne to nešlo skompilovať a kompilátor zahlásil podivnú chybu.

Zvykol som si na týchto stránkach skracovať zdrojáky, aby som upozornil len na konkrétnu informáciu a predpokladal som, že si každý bude sťahovať zdroják kompletný z hyperlinku na konci článku. Moje skrátené zdrojáky vyzerajú takto.

int x=1;
...
int y=2;

Pretože dlhé roky píšem v C++, mne je takýto zápis vždy jasný a hneď vidím, že sa jedná o niečo skrátené. Ale tento prípad mi ukázal, že menej skúsený programátor takéto veci nevidí, pretože nevie hneď rozoznať, kde je niečo syntakticky nesprávne. A preto som sa rozhodol vylepšiť písanie blogu a keď urobím takýto skrátený zápis, radšej na to dopredu upozorním. Grafika článku bude vyzerať po úprave takto.

Nasledujúci kód je skrátený. Nie je možné ho priamo skompilovať. Plnú verziu si môžete stiahnuť z GitHub.

int x=1;
...
int y=2;

Verím, že v takejto podobe to prospeje čitateľnosti textu a každého bude navigovať na miesto, kde sa nachádza kompletný zdrojový text.


13.12.2016


Menu