Koodin muotoilua

Java-koodin oikeanlainen muotoilu ei ole välttämättä ollut kaikkialla kovassa huudossa aiemmin, ja allekirjoittanutkin on karsastanut tyylipoliisien toimia. Yhdenmukaisesta muotoilusta on kuitenkin erittäin paljon hyötyä koodin luettavuuden ja ymmärrettävyyden kannalta, ja siksi itse kunkin kannattaakin tutkia ja mahdollisuuksien mukaan ottaa käyttöön Sunin Java Coding Conventions.

http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Näiden seuraaminen on kuitenkin aika työlästä, ellei työkalu tee sitä sinun puolestasi. Eclipseen löytyy mainio Checkstyle-plugin, joka tekee tarkistukset koodaajan puolesta. Vaikkei kaikkia suosituksia seuraisikaan ( esimerkiksi kaikkien attribuuttien java docsit jne. ), antaa checkstyle paljon hyviä kommentteja ja vinkkejä oman tyylin yhdenmukaistamiseksi ja kehittämiseksi.

http://eclipse-cs.sourceforge.net/basic_setup_project.html

Samalla Eclipsessä kannattaa asettaa Eclipse muotoilemaan koodit oikein:

”Window” -> ”Preferences” -> ”Java” -> ”Code Style” -> ”Formatter” -> ”Show” button on right -> ”Show Profile ’Eclipse [built-in]'”

Indentation -> Spaces only.

Tuon jälkeen kun koodi-ikkunassa tekee ctrl+a ja ctrl+i, muokkaa Eclipse intendoinnin yhdenmukaiseksi käyttäen vain välilyöntejä. Lopputuloksena on paremmin luettavaa koodia myös muilla koneilla.

Jos haluaa oikein kehittää omaa koodiaan ja tappaa bugeja jo ennen kuin niitä ehtii syntyä, kannattaa kokeilla esimerkiksi FindBugs-työkalua, joka tunnistaa koodista erilaisia patterneja, jotka voivat aiheuttaa virheitä.

http://findbugs.sourceforge.net/manual/eclipse.html

Työkalut eivät tietenkään korvaa asioiden ymmärtämistä ja opettelua, mutta ovat loistava apu koodaajan tueksi spottaamaan kaikkein yksinkertaisimmat virheet ja puutteet.

This entry was posted in Uncategorized. Bookmark the permalink.

Vastaa

Täytä tietosi alle tai klikkaa kuvaketta kirjautuaksesi sisään:

WordPress.com-logo

Olet kommentoimassa WordPress.com -tilin nimissä. Log Out / Muuta )

Twitter-kuva

Olet kommentoimassa Twitter -tilin nimissä. Log Out / Muuta )

Facebook-kuva

Olet kommentoimassa Facebook -tilin nimissä. Log Out / Muuta )

Google+ photo

Olet kommentoimassa Google+ -tilin nimissä. Log Out / Muuta )

Muodostetaan yhteyttä palveluun %s