ITI0011-13-Checkstyle

Checkstyle plugin Eclipse'ile

Aine "Programmeerimise põhikursus Javas" (ITI0011) raames on oluline, et lähtekood vastaks võimalikult Java kodeerimise standardile. Selleks saab kasutada Eclipse'is pluginat nimega Checkstyle. See leht kirjeldab, kuidas antud pluginat endale installida ja kasutada.

Checkstyle plugini installimine

Märkus: seda sammu ei pea läbima, kui kasutate ITI0011 lehel tööriistade all pakutavad Eclipse'i pakki (selles on Checkstyle plugin juba installitud).

Eclipse (versioon 4.3) puhul menüüst: Help > Eclipse Marketplace.
Avaneb Marketplace dialoog: Find "Checkstyle" > kuvatakse leitud pluginad. Valida esimese "Checkstyle Plug-in" pakutava juures "Install".

Installeerimisel küsitakse erinevaid küsimusi (tingimustega nõustumine - "accept", kolmanda osapoole tarkvara installeerimine - "ok", Eclipse'i restart - "ok").

Checkstyle plugini seadistamine

Kui plugin in installitud, siis tuleb talle ette anda ITI0011 aines jaoks koostatud konfiguratsioonifail. Selleks menüüs: Window > Preferences.
Avaneb seadete dialoog. Võite kohe vasakul menüüst valida "Checkstyle" või kasutada otsingut üleval. Valides seadete alt õige menüü, avaneb teil vaade, kus kuvatakse kasutada olevad konfiguratsioonid. Seal peaks algselt olema kaks "Sun Checks" nimelist seadistust.

Uue lisamiseks: "New...".
Avaneb dialoog. Valida type "Remote configuration". Name: ITI0011. Location: http://iti0011.googlecode.com/git/2013/checkstyle/iti0011.xml . "OK".
Checkstyle seadete vaates valige äsja loodud konfiguratsioon nimega "ITI0011" ja vajutage "Set as Default".

Sellega on plugin seadistatud Eclipse'i jaoks. Projekti seadistuse kohta lugege edasi.

Checkstyle plugini aktiveerimine projekti jaoks

Kui eelnev seadistus on tehtud, tuleb plugin iga projekti puhul aktiveerida. Selleks:
Project explorer vaates (üldiselt asub vasakul ääres) projekti nime peal parem klikk > Properties.
Avaneb projekti seadete dialoog. Vasakul menüüst valida "Checkstyle" (või kasutada otsingut selle leidmiseks). Avanevas vaates on kohe kõige ülemine valik "Checkstyle active for this project", märgistage see checkbox ära. Lisaks kontrollige, et valitud konfiguratsioon on õige (mõned read allpool on dropdown, kust saate valida konfiguratsiooni, seal peaks valitud olema "ITI0011"; kui ei ole valitud, siis valige). "OK".

Plugin küsib, kas projekt rebuild'ida, valige "Yes".

Sellega peaks plugin olema seadistatud projekti jaoks. Nüüdsest näete lähtekoodis kollasega esiletoodud probleeme, mis tuleks kodutööde esitamiseks lahendada (ideaalis ei tohiks kodutöö lähtekoodis ühtegi kollast kohta olla).