top / index / target / source

資料: Java言語ソースファイルのスタイルおよび調整ツール

いがぴょんの日記 日記形式でつづる いがぴょんコラム ウェブページです。

old-v2

Java言語ソースファイルのスタイル整形に関するメモ。astyleやcheckstyleなどのメモ書きが含まれます。

資料: Java言語ソースファイルのスタイルおよび調整ツール

いがぴょんのウェブページトップへ戻る

Java言語コーディング規約

そもそも Java言語コーディング規約にまつわるものとして、下記があります。(そしてこの２つが有名です)

オマケ

以下はEclipse主体です

Eclipseのソースコード・フォーマッタによるソースコード整形

オープンソースなJava統合開発環境として有名なEclipseには ソースコード・フォーマッタが標準搭載されています。基本的に Java言語の標準的な規約に従ったソースコード整形を行ってくれます。(完全に Java言語コーディング規約に合致していない点に注意)

Eclipse Checkstyleプラグイン

転記する気力が萎えてしまいました

Eclipse PMDプラグイン

転記する気力が萎えてしまいました

Eclipse FindBugsプラグイン

以下はコマンドライン主体です

Javaソースファイル整形ツール Artistic Style (astyle)

通称astyleという、GPLライセンスなJavaソースファイル整形ツールです。astyle -j --style=java -p -s ファイル名.java のようにスイッチを使うと、Java言語コーディング規約 にそこそこ合致したソースコードを得ることが出来ます。

Javaソースファイル構文チェックツール checkstyle

様々な Java構文合致状態をチェックしてくれるツールです。こちらは astyleとは異なり自動整形はしてくれません。その代わり かなり正確にJava言語コーディング規約との整合性チェックを報告してくれます。

お好みツール

上記を組み合わせて お好みなバッチを作成して使っています。 st.bat echo off rem Javaソースファイルのスタイル整形＆チェックツール echo astyle実行 astyle -j --style=java -p -s %1 %2 %3 %4 %5 %6 %7 %8 %9 rem checkstyle-all-2.3.jar を CLASSPATHが通ったところに配置してください。 echo checkstyle実行 java com.puppycrawl.tools.checkstyle.Main %1

  diff -urN %1.orig %1

これで st ファイル名.java のように指定すれば、ソースファイル整形とソースファイルのスタイルチェックとがいっぺんに起動できます。

更新履歴

この日記について