コーディング規約 トップページJava コーディング規約 目次 

1.ソースファイルの構成

 ここでは,1つのソースファイルをどの様に構成するかを述べる。

1.1 ソースファイルの記述例

 ソースファイルの記述例を以下に示す。
 ソースファイルの履歴のコメント,ソースファイルの頭書きなどは以下の順番で記述する。

■ ファイルの記述例

// @(h) Form1.java     ver 1.1 ( '07.09.20 今井 浩司 )
// @(h) Form1.java     ver 1.0 ( '07.09.15 今井 浩司 )

// @(s)
//  Form1クラスのサンプルソース
//  ボタンクリック処理を含む全ての画面の処理を
//  このファイルに記述する。
//

package Sample;

import System.Drawing.*;
import System.Collections.*;
import System.ComponentModel.*;
import System.Windows.Forms.*;
import System.Data.*;

public class Form1 extends System.Windows.Forms.Form//Form1の概要
{
  private System.Windows.Forms.Button button1;
  private System.ComponentModel.Container components = null;

  public static final int LOOP_COUNT = 2;
  public static int nSize = 0;

  //
  // 機能 : ボタンをクリックされた時の処理
  //
  // 機能説明 : ボタンをクリックされた時の処理を行う。
  //        クラス定数LOOP_COUNT回、ダイアログを表示する。
  //
  // 返り値 : なし
  //
  // 備考 : 簡単なサンプルです。
  //
  private void button1_Click (Object sender,     // 発生イベントオブジェクト
                 System.EventArgs e) // イベント引き数
  {
  int i;
  String Buf;
 
   /// 固定文字列を代入する
   Buf = "回目のボタンの文字列";

   /// 以下の処理を、LOOP_COUNT回行う
   for (i = 0; i < LOOP_COUNT; i++)
   {
    String MessageString;

    //// 文字列を連結してダイアログに表示する
    MessageString = i + Buf;
    MessageBox.Show(MessageString);
   }
  }

  /**
   * JavaDocの説明でも、これらのタグはコメントを抽出できます。
   * 複数行にまたがった説明も記述できます。
   *
   * @param 引き数はこのように記述します。
   * @return 返り値はこのように記述します。
   * @author 作成者はこのように記述します。
   * @version バージョンはこのように記述します。
   * @since 導入バージョンはこのように記述します。
   * @see 関連項目はこのように記述します。
   * @exception 例外はこのように記述します。
   * @deprecated 説明はこのように記述します。
   */
  private void JavaDoc()
  {
   /// メソッド内のコメントはこのように記述します。
  }
}