( Hevi | 2013. 12. 18., sze – 12:11 )

JSDoc, JavaDoc persze, hogy kell, de én elég sokszor érzem, hogy a checkstyle ugyan kierőszakolja, de semmi értelme, mert a függvény neve és szignatúrája elég jól definiálja, hogy mit is csinál.

Hogy szem előtt van-e, az szintén más kérdés. Szem előtt van egy osztály privát függvénye is, amit hívni szeretnél, de JS esetén nem elég ránézni a függvény szignatúrájára, értelmezned is kell a függvényt. Míg pl. Javaban el tudod fogadni azt, hogy a függvény azt csinálja, ami a neve és azzal, amik a paraméterei.

Hasraütéses példa:

JS:
function getPhoneNumber(person){};

Java:
PhoneNumber getPhoneNumber(Person person);

JS esetén nem tudom mit ad vissza, ha nem olvasom el a JSDocot, vagy a függvény törzsét. Sőt, azt se feltétlen tudom, hogy a person az mi, de ezt mondjuk még meg lehet indokolni.

Java esetén már a függvény deklarációjából tudom, hogy ez egy PhoneNumber-t fog visszaadni, és ezt egy Person-ból veszi. JavaDoc tök felesleges.

A fenti példa szerint a JS-t több effort karbantartani. JSDocot kell írni és karbantartani, és/vagy át kell nézni a függvénytörzset.