谷本 心 in せろ部屋

はてなダイアリーから引っ越してきました

SMGのコーディング規約とEclipse設定ファイルが公開された模様

弊社の公式Twitterアカウント (@smg_tw) のTLに、こんなの発見。

そこで、当社では、社内で2000年より作成・改版を行ってきたJavaコーディング規約を
公開することにしました。


このコーディング規約は、開発者自身の経験、および、最近のJavaの動向を踏まえ、
現場で本当に役に立つノウハウをまとめたものです。
そのため、Eclipseで自動でフォーマットできるような簡単なスタイルの規約については
記述を省略し、より重要となるコーディングテクニックや考え方について記述しています。

Javaコーディング規約/WEBワークショップ エスエムジー株式会社

SMGのコーディング規約と、Eclipseのフォーマッタ設定ファイルです。


Javaエンジニアの皆様方におかれましては、
顧客から標準コーディング規約という謎のPDFファイルを渡されてウンザリしたり、
「いいからEclipseのフォーマッタでよこせ」といきり立った
記憶の2つや3つあると思います。


かと言って、逆の立場になったときに、Eclipseのフォーマッタ、警告設定、
さらにCheckstyle / FindBugsの設定一式だけを用意してみても、
「メソッド名は動詞で始める」などなどカバーしきれないものが多かったりして、
Javaの鉄則」とか「Effective Java」をイチから読んでもらう時間もなくて、
やっぱり、最低限のコーディング規約のドキュメントがあった方が
良いのかなと思ったりした経験があるやも知れません。


ということで、
そんなEclipseフォーマッタと、コーディング規約が
セットで公開されてましたので、ぜひ利用してください。


ちなみにSMGは今でもBSD/オールマンスタイルを貫いているので、
公開されたEclipseフォーマッタもその設定になっていますが
JavaならK/Rスタイルだろ、JK」という皆さんは、設定を修正して利用してください。


ところで、このコーディング規約のPDFの末尾に書いていますが、
コーディング規約の会(オブジェクト倶楽部) にある
ISIDのJavaコーディング規約を参考にさせてもらっているようです。
こちらも非常に良いドキュメントなので、私もよく利用させてもらっています。