本ドキュメントはJava開発における開発標準化規約を定めた資料である。
本ドキュメントはJava開発における開発標準化規約を定めた資料である。
下記の資料を参考とした。
本ドキュメントは下記の構成としている。
【記述例】 /* * ○○プロジェクト * * 【クラス名】 * SampleClass * * 【Copyright】 * All Rights Reserved,Copyright(C) arison.jp Limited 2012- */
【記述例】 /** * SampleClass
* Helloを画面に出力する。<br> * @author Arison */ public class SampleClass { }
【記述例】 /** トップ画面ID */ public static final String ID_= "00000000";
【記述例】 /** * 半角文字チェック。<br> * 半角文字のみの文字列かどうかを判定するメソッド。<br> * targetのnullチェック等は行わない。<br> * @param target * チェック対象文字列 * @return boolean 半角文字チェック結果 * <ul> * <li>true:半角文字のみ</li> * <li>false:半角文字以外が含まれる</li> * </ul> */ public static boolean isHalfCharOnly(String target) {
【定義例】 // 著作権情報 public static final String COPYRIGHT = "All Rights Reserved,Copyright(C) arison.jp Limited 2012-"; // 秘密情報 public static final String CONFIDENTIAL = "arison.jp CONFIDENTIAL";
ファイルを新規に作成する場合はコードテンプレートを使用することを徹底し、アウトラインを統一する。 コミット前に、checkStyleによるチェックを行う コードフォーマッタを使用することを徹底し、コーディングの記述を統一する。 コードテンプレート は、「デフォルトの設定」を使用する。 checkStyle は、「デフォルトの設定(Sun Checks)」を用いる。 コードフォーマッタ は、「デフォルトの設定」を使用する。
//(1) ソースヘッダコメント /* * ○○プロジェクト<br> * * 【クラス名】 * SampleClass * * 【Copyright】 * All Rights Reserved,Copyright(C) arison.jp Limited 2012- */ //(2) パッケージ宣言 package jp.arison; //(3) インポート宣言 import jp.arison.util.DataCheck; //(4) クラス、インターフェース宣言 /** * SampleClass
* Helloを画面に出力する。<br> * * @author Arison */ public class SampleClass { // 著作権情報 public static final String COPYRIGHT = "All Rights Reserved,Copyright(C) arison.jp Limited 2012-"; // 秘密情報 public static final String CONFIDENTIAL = "arison.jp CONFIDENTIAL"; // (5) クラス変数宣言(Static変数) /** Helloメッセージ */ public static final String MSG_HELLO = "Hello"; // (6) インスタンス宣言(Static変数以外) /** メッセージ */ private String outputMsg = null; // (7) コンストラクタ /** * コンストラクタ */ public SampleClass() { // 何もしない } // (8) メソッド /** * メッセージを出力するメソッド。<br> * 入力データがNullの場合、例外発生時には何も出力をしない。<br> * * @param inData * 入力データ * @throws Exception * チェック時に例外が発生した場合 */ public void outputMessage(String inData) throws Exception { if (inData == null) { return; } DataCheck.checkValue(inData); outputMsg = createMessage(inData); System.out.println(outputMsg); } /** * 入力データ前にHelloメッセージをつけた文字列を返すメソッド。<br> * * @param inData * 入力データ * @return inDataの前にHelloメッセージをつけた文字列 */ private String createMessage(String inData) { return MSG_HELLO + inData; } }