Stiilivigade näitamine IntelliJ's

Lisame IntelliJ-sse Checkstyle-IDEA nimelise laienduse (plugin), mis kontrollib koodi juba kirjutamise ajal.

Samm 1: Seaded

Avage seaded:

  • Windowsi peal: File -> Settings

  • MacOS peal: IntelliJ IDEA -> Settings

../../_images/checkstyle_new_1_file_settings.png

Samm 2: Plugins menüü

Avage vasakult Plugins menüü (punase noolega märgistatud):

../../_images/checkstyle_new_2_plugins.png

Klikkige üleval oleval "Marketplace" nuppu (punase noolega märgistatud)

Samm 3: Otsige õige plugin üles

Avaneb nimekiri saadaval olevatest pistikprogrammidest:

../../_images/checkstyle_new_3_install.png

Järgnevalt:

  1. kirjutage otsingulahtrisse "checkstyle"

  2. valige nimekirjast "Checkstyle-IDEA"

  3. klikkige "Install" nupul

Samm 4: IntelliJ restart

Vajutage "Restart IDE" nuppu.

../../_images/checkstyle_new_4_restart.png

Samm 5: Checkstyle seaded

Avage uuesti seaded (File -> Settings).

Kirjutage vasakule üles otsingulahtrisse "checkstyle". Seejärel näidatakse teile vasakul vaid seda osa menüüst, mis sisaldab otsisõna.

../../_images/checkstyle_new_5_settings.png

Valige Other Tools -> Checkstyle.

Samm 6: Aine konfiguratsioon

Vaikimsi kaasas olev seadistus on liiga karm. Kasutame ITI0102 aines määratud seadistust. Seadistuse saab siit: https://iti0202.pages.taltech.ee/public/files/checkstyle.xml

../../_images/checkstyle_new_6_new_conf.png
Järgnevalt:

  1. vajutage "+" märgi peale, avaneb uus aken

  2. Uues aknas kirjutage uue seadistuse nimetus

  3. Valige "Use a Checkstyle file accessible via HTTP"

  4. Sisestage seadistuse URL

Vajutage "Next" ja sulgele aken.

Samm 7: Aktiveerimine

Peale konfiguratsiooni lisamist tuleb see ka aktiveerida.

../../_images/checkstyle_new_7_activate.png

Selleks märgistage valikuruut "Treat Checkstyle errors as warnings" ning valikruut loodud seadistuse ees (joonisel punased ringid ümber tehtud).

Samm 8: Näidis

Näide koodist:

../../_images/checkstyle_new_8_example.png

Meetodil getHello on paramString parameetri kirjeldus puudu. Seepärast on sellele kollane joon alla joonistatud.

Samuti on meetodi kirjelduses puudu kirjeldus tagasutse kohta (@return).

SonarLint

Samuti soovitame paigaldada SonarLint pistikprogrammi. SonarLint teeb samu asju, mida Checkstyle, aga lisab juurde ka pikemaid kirjeldusi, kui mingi stiiliviga esineb.

Paigaldamiseks korrake samme 1-4, kuid Checkstyle asemel otsige SonarLint.

../../_images/checkstyle_new_9_sonar.png

Näide

../../_images/checkstyle_new_10_sonar_example.png

Antud meetodil on tagastustüüp ArrayList<String>, mis on spetsiifiline implementatsioon List liidesest. Heade tavade järgi tagastatakse üldine liides, et siis arendaja, kes antud meetodit kasutab, saab ise valida, millist implementatsiooni kasutada.

../../_images/checkstyle_new_11_sonar_context.png

Mõndasid stiilivigu oskab SonarLint ise parandada, kuid praegu meid huvitab pigem kirjeldus vea kohta

../../_images/checkstyle_new_12_sonar_desc.png

Avaneb aken, kus kirjeldatakse viga ära ning näidatakse nii õiget kui ka valet lähenemist.