Treść książki
Przejdź do opcji czytnikaPrzejdź do nawigacjiPrzejdź do informacjiPrzejdź do stopki
dokumentacjitużnadkonstrukcjami,takimijakfunkcjeizmienne,orazichformatowa-
nia.Otoprzykład,równieżwyjętyzkontekstu:
/**
*Sprawia,żepaintermalujeokreślonyobraz(painting).
*
*@param{Painting}painter
*@param{string}painting
*@returns{boolean}Czypainternamalowałobraz(painting).
*/
functionpaintPainting(painter,painting){/*...*/}
StandardJSDocmapewneniedogodności,któreutrudniająjegoużyciewdużych
projektach:
•NicniewymuszapoprawnegoopisukoduwdokumentacjiJSDoc.
•
Nawet,jeśliopisyJSDocbyływcześniejpoprawne,podczasrefaktoryzacjikodu
możnanapotkaćnatrudnościwznalezieniuwszystkichnieważnychkomentarzy
JSDoczwiązanychzwprowadzanymizmianami.
•
Opisywaniezłożonychobiektówjestnieefektywneirozwlekłe.Wymagawieluosob-
nychkomentarzydefiniującychtypyirelacjemiędzynimi.
UtrzymaniekomentarzyJSDocwkilkunastuplikachniejestzbytczasochłonne,ale
wprzypadkuseteklubtysięcystaleaktualizowanychplikówmożebyćwyzwaniem.
Słabszenarzędziaprogramistyczne
PonieważJavaScriptnieoferujewbudowanychsposobównaidentyfikacjętypów,akod
łatwowymykasięopisomzkomentarzyJSDoc,automatyzacjawielkichzmianlubuzy-
skaniewgląduwkodźródłowymożebyćtrudne.ProgramiścijęzykaJavaScriptzwykle
sązdumienicechamijęzykówtypowanych,takichjakC#iJava,dziękiktórymmożna
zmieniaćnazwyczłonkówklaslubprzeskakiwaćdomiejscadeklaracjitypuargumentu.
Byćmożezaprotestujesztwierdząc,żenowoczesneśrodowiskaprogra-
mistyczneIDE,takiejakVSCodeoferująpewnenarzędziaprogrami-
styczne,np.automatycznąrefaktoryzacjękoduJavaScript.Toprawda,
alewtymceluwtlewykorzystująTypeScriptlubjegoodpowiednik.
Ponadto,wprzypadkuwiększościkoduJavaSciptniesątaksolidnejak
dobrzenapisanykodTypeScript.
ProblemyzczystymjęzykiemJavaScript
|
5
