A dokumentáció jelentősége

Most, hogy már írtál néhány programot, lehet, hogy felmerült benned, hogy hogy tudnád ezt az összes parancsot megjegyezni? Oval(), vagy circle(), vagy ellipse() volt? Szélesség és magasság, vagy magasság és szélesség? Ezt mind meg kellene jegyeznem? Szerencsére nem! Erre való a számítógép. A számítógép mindig előttünk van, amikor programozunk, és remekül emlékszik dolgokra, jobban, mint mi. Tehát mi lenne, ha helyettünk a számítógép emlékezne mindenre, mi pedig úgy használnánk, mint egy szótárt a programozáshoz? Így csak azzal kéne törődnünk, hogy remek programokat írjunk, a sok unalmas részletet meg nem kéne észben tartanunk. Ezt hívjuk dokumentációnak, ami egy olyan dokumentum, amely elmagyarázza, hogyan kell egy programnyelven és környezetben dolgozni, példákkal és gyakori hibákkal, így ha nem emlékszünk a pontos részletekre, semmi baj! Csak kikeressük őket. Ha azt gondolod, hogy unalmas dokumentációt olvasgatni, igazad is van, sokkal jobb kódot írni, de hacsak nem akarsz mindent megjegyezni, meg kell tanulnod használni a dokumentációt, hogy tudd az ötleteidet kódolni. Még a nagy programozók sem próbálnak meg mindent megjegyezni. Sőt, általában a nagy programozók a legjobbak a dokumentáció olvasásában. Például rajzolok egy mosolygós arcot, már megrajzoltam az arcát, a szemét az ellipse függvény használatával, amit jól ismerek, de még nem vagyok kész. Először is szeretném az arcot kihúzni vastag körvonallal, emlékszem is, hogy a stroke paranccsal kapcsolatban kell valamit csinálnom, de nem emlékszem pontosan a nevére. Tehát ahelyett, hogy itt ülnék és megpróbálnám feltalálni, ami órákig, vagy akár a végtelenségig is eltarthat, csak rámegyek a dokumentáció fülre, és körülnézek ott, hátha megtalálom, amit keresek. Megnézem a színezés kategóriában, ez ésszerűnek tűnik, megnézem itt a függvényeket, és a legvégén meg is találom a strokeWeight parancsot, a vonalak és körvonalak vastagságának megváltoztatásához. Tehát itt láthatjuk a függvény nevét és a paramétereket - most csak egyet. Én azzal szoktam kezdeni, hogy átmásolom és beillesztem a kódomba. Így. De azonnal kapok is egy hibajelzést: 'thickness nincs definiálva'. Ez azért van, mert a vastagság ('thickness') csak példaként van odaírva, nem pedig egy valós érték, ezt át kell írnom arra, amit valójában szeretnék, azaz egy számra, vagy akár egy változóra is, ami valamilyen számot jelent. Most egy számot írok be. Jó, a 10 jó lesz, ezzel persze még eljátszogathatunk. Na ez egy kicsit túlzás, ez meg túl kevés. Úgyhogy menjünk vissza, 12 jó lesz. Ez meg is van, nézzük tovább. Valami még nyilvánvalóan hiányzik a mosolygós arcról: a mosoly. Szóval ugye kéne ide valami ilyesmi... De ha megnézem, ez nem úgy néz ki, mint amit meg tudnék oldani ellipse(), line() vagy rect() paranccsal, mert ív van benne, de nincs belseje. Úgyhogy azt gondolom, hogy megnézem a doksikat, hátha van benne valami más, amivel ilyen ívet lehet rajzolni Jó, menjünk akkor a doksikhoz! Legörgetek, és körülnézek a kategóriák között, Megnézem az alakzatokat... Aha! Itt is van! A legelső az arc(), ami egy ívet rajzol ki, és nekünk pont ez kell, hiszen a mosoly pont egy ív! Ebben viszont sokkal több paraméter van. Először is bemásolom mindezt ide... Azt ugye nem felejted el, hogy ezek itt csak példák, úgyhogy ezeket mind ki kell cserélnem arra ami szerintem jó lesz nekünk... Jó. Monjuk, hogy az x-szel és az y-nal akarom kezdeni, ha a közép 100, akkor kezdhetnénk mondjuk 150-nél, és akkor az y pedig lehetne 250, és a szélesség pedig - az gondolom a körív szélessége, tehát valószínűleg kicsit kevesebb, mint a teljes arc szélessége - mondjuk 200, a magasság pedig az valószínűleg az ív felső részétől az alsóig tart, úgyhogy legyen mondjuk 50. Menjünk tovább. Start. Start és stop. Hmm...Nem igazán tudom, hogy ezek mik... Na, most elakadtam, mert nézem ezt a függvényt, próbálom használni, de nem értem ezeket a paramétereket. Szerencsére viszont visszamehetünk a doksikhoz, ráklikkelek a keresett függvényre ez feldob egy programot, ami megmutatja, hogyan kell a függvényt használni, és elmagyarázza a paramétereket részletesen. Tehát ha ezt megnézzük, x az x koordináta, az ellipszis közepéhez, amit az ívből származtattunk. Tehát amikor ívet rajzolunk, az tulajdonképpen olyan, mintha egy ellipszist rajzolnánk, de csak egy részét, és mindent ez alapján számolunk ki. Szóval az x és y a képzeletbeli ellipszisünk közepe a szélesség és magasság ennek az elképzelt ellipszisnek a szélessége és magassága és start és stop, na ezeket nem tudtam. Start és stop a szög... ja már, értem, a start a kezdő szög, ahol elkezdjük az ívet, fokban megadva, és a stop ahol befejezzük a rajzolást. Megnézhetjük itt a példákat, körív 1-től 270-ig, az valószínűleg ez lesz itt, mert 1 foktól 270-ig megy, ez pont így nézne ki. Próbáljuk meg megváltoztatni. Így ni. Ez világos, 1-től 180-ig ez az ami nekünk is kell, igaz? Mert egy félkörívet szeretnénk. Azt hiszem, értem már az arc()-ot, annyira, hogy tudjam használni. Menjünk is vissza a mosolygós arcunkhoz! Jó, tehát 0-tól 180-ig megyünk... már majdnem kész. Az x kilóg, mert nem tudtam, hogy az x valójában az ellipszisem közepe. Egy kicsit széles is, úgyhogy vegyük kisebbre. Így. Haha! És már meg is van! Van egy mosolygós arcom! A dokumentációnak köszönhetően sokkal gyorsabban tudtam megcsinálni, amit akartam. És ez a programozás célja - megvalósítani az ötleteinket gyorsabban. Ne feledd: használd a doksikban rejlő erőt!