本文へジャンプ メニューへジャンプ

富士通

  1. ホーム >
  2. ソフトウェア >
  3. SIMPLIA >
  4. 製品ラインナップ >
  5. SIMPLIA/JF Kiyacker 開発標準規約例
ここから本文です

SIMPLIA/JF Kiyacker 開発標準規約例

SIMPLIA/JF Kiyackerには以下の開発標準規約があります。

コーディング規約
規約コード分類重要度規約内容チェック内容
K1C10006宣言と文A内側の宣言が外側の宣言を隠さないように、異なった変数名が使用されていること。フィールド変数とローカル変数に同一名の変数が存在するか。
K1C10041{} (中括弧 中括弧とじ)A“{ (中括弧)”は宣言行の末尾に記述されていること。
“} (中括弧とじ)”は単独の行とし、適切なインデントがされていること。		“{ (中括弧)”が宣言行の末尾に記述されているか。
“} (中括弧とじ)”は単独の行で記述されているか。
“{ (中括弧)”、および、“} (中括弧とじ)”が存在する行のインデントが同じか。
K1C10049宣言と文A3次元以上の配列は使用してはいけない。規定数以上の配列が使用されていないか。

元のページへ戻る

ページの先頭へ

コメント規約
規約コード分類重要度規約内容チェック内容
K1C20001共通Aソースの先頭部分にヘッダーコメントが記述されていること。
・ブロックコメント形式（/* … */）
・copyright情報（ソースファイル名, VL,著作権表示、作成年)
・システム区分、業務区分
・クラス一覧（クラス名、概要）
・履歴（日付、VL（1.0 を初版とし、変更を加える毎に 0.01 ずつ増加させる 。）、作成者・更新者、更新内容）

（記述例）
/*
*YosanIchiran.java V10L10 Copyright FUJITSU LIMITED 2001
*システム名（AAAシステム） 業務区分名（予算業務）
*クラス一覧：
* NO クラス名 概要
* 1 YosanIchiran 予算の一覧画面
*履歴：
* NO 日付 Ver 更新者 内容
* 1 1999/10/01 V10L1 富士通）山田 初版。
* 2 1999/11/09 V10L1.01 富士通）佐藤 計算方法
* を変更。
*/		ソースファイルの先頭にブロックコメント (/* */) が存在するか。
K1C20002共通Ajavadoc出力はリファレンスマニュアルとなるため、説明は「ですます」調で統一されていること。 javadocコメント (/** */) 内の文末が指定された表現（例 「です」「ます」「ません」 など）となっているか。
・文末の判定は、規約コード K1C20004 で指定された内容が適用される。
規約コード K1C20004 で「。(句点)」が指定された場合は、文末が指定された表現「です。(句点)」「ます。(句点)」「ません。(句点)」となっているか。
規約コード K1C20004 で「．(ドット)」が指定された場合は、文末が指定された表現「です．(ドット)」「ます．(ドット)」「ません．(ドット)」となっているか。
K1C20003共通Aコメントは必要に応じて、日本語で見やすく記述する。チェック機能なし。
K1C20004共通A文章は“。(句点)”で終了していること。 javadocコメント (/** */) の文末を「。(句点)」とした場合に「．(ドット)」で終了していないか。
また、文末を「．(ドット)」とした場合に「。(句点)」で終了していないか。
K1C20011クラスAクラスのコメントがクラス宣言の直前行に記述されていること。
コメント中にjavadocタグ @author , @versionが記述されていること。
・機能概要（クラス名、クラス説明、備考）
・版数
・作成者：所属と氏名（フルネーム）を記述
（記述例）
/**
* <dd>クラス名：予算一覧
* <dd>クラス説明：画面から選択された予算一覧を表示する。
* 過去に登録された予算の一覧が呼び出せる。
* 一覧から 一件の予算原選択するとその内容が詳細画面に反映される。
* <dd>備考：
* @version 1.01 2000/10/01
* @author 富士通)富士通太郎
*/
public class xxxxxx extends LWPanel {
}		クラス（インターフェース）にjavadocコメント (/** */) が記述されているか。
コメント中に指定されたjavadocタグが記述されているか。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1C20012変数A変数のコメントは変数定義の直前行に記述されていること。
コメント中に指定されたjavadocタグ（例 など）が記述されていること。
・変数の日本語名称
・変数の内容記述（省略可能）
（記述例）
/**
* 販売取引条件 No
*/
public TextFieldString txStr_HanbaiTorihikiZyoukenNo;		フィールド変数にjavadocコメント (/** */) が記述されているか。
コメント中に指定されたjavadocタグが記述されているか。
注意)
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1C20013メソッドAメソッドのコメントは、メソッド定義の直前行に記述されていること。
コメント中に指定されたjavadocタグ（例 など）が記述されていること。
・機能概要（メソッド名、メソッド説明、備考）
・引数説明：引数の名前、引数の内容を記述。複数ある場合は行を複数行記述する。
・戻り値説明：戻り値の型、戻り値の内容を記述。
・例外説明：例外の型、例外の発生する条件を記述。（メソッドでthrowsしているものを記述）
（記述例）
/**
* <dd>メソッド名：従業員検索
* <dd>メソッド説明：指定された検索条件で、従業員マスタから従業員情報を検索する。
* <dd>備考：
* @param inView 従業員検索条件
* （xx.yosan.entity.xxx.IOView）
* @return IOView 従業員情報
* （xx.yosan.entity.xxx.IOView）
* @exception BusinessRuleException
* inView の中の従業員コードが null だった場合
* inView で指定された従業員コードが検索できなかった場合
*/
public IOView createOutView(IOView inView) throws
BusinessRuleException {
...
}		メソッドにjavadocコメント (/** */) が記述されているか。
コメント中に指定されたjavadocタグが記述されているか。
@paramが指定されている場合、@paramとメソッドのパラメタの個数および名前が同一か。
@exception (@throws) が指定されている場合、@exception (@throws) とメソッドのthrowsの型が同一か。@exceptionが指定されているのに@throwsで記述されているか、またはその逆の場合は違反となる。
@returnが指定されている場合、@returnとメソッドの戻り値の型が同一か。
注意)
名前の一致は部分一致で判定。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1C20014コンストラクタAコンストラクタのコメントは、コンストラクタ定義の直前行に記述されていること。
コメント中に指定されたjavadocタグ（例 など）が記述されていること。		 コンストラクタにjavadocコメント (/** */) が記述されているか。
コメント中にjavadocタグが記述されているか。
@paramが指定されている場合、@paramとコンストラクタのパラメタの個数および名前が同一か。
@exception (@throws) が指定されている場合、@exception(@throws)とコンストラクタのthrowsの型が同一か。
注意)
名前の一致は部分一致で判定。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に _,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。

元のページへ戻る

ページの先頭へ

命名規約
規約コード分類（1）分類（2）重要度規約内容チェック内容
K1N10002クラス名／インターフェース名共通A先頭文字は英大文字で始められていること。クラス名、または、インターフェース名の先頭文字が英大文字で始められているか。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に _,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1N10003クラス名／インターフェース名共通Aクラス名は、名詞または名詞句で表現されていること。不必要な省略はしないこと。
プレフィクスがABCの場合
例： ABCStatusbar, ABCCheckList, ABCPassbookPrinter		チェック機能なし。
K1N10004クラス名／インターフェース名共通A2つ以上の単語を使用する場合は、1つめの単語の先頭のみ大文字で記述されていること。チェック機能なし。
K1N20001変数名フィールド変数A文字種は半角英数字と追加文字種のみであること。フィールド変数名に半角英数字と追加文字種以外の文字種が使用されていないか。
K1N20002変数名フィールド変数A先頭文字は英小文字であること。フィールド変数名の先頭文字が英小文字で始められているか。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1N20003変数名フィールド変数A2つ以上の単語を使用する場合は、後ろの単語の先頭文字が大文字であること。チェック機能なし。
K1N20004変数名フィールド変数A予約語以外で使用不可の文字列（com）を使用していないこと。フィールド変数名に規定の文字列が使用されていないか。
K1N20008変数名定数A文字種は半角英数字と追加文字種のみであること。定数に半角英数字と追加文字種以外の文字種が使用されていないか。
K1N20009変数名定数A定数の英文字はすべて大文字で記述する。英文字以外はチェック対象外とする。定数の英文字がすべて大文字で記述されているか。
K1N20013変数名ローカル変数A文字種は半角英数字と追加文字種のみであること。ローカル変数に半角英数字と追加文字種以外の文字種が使用されていないか。
K1N20014変数名ローカル変数A先頭文字は英小文字のみであること。ローカル変数の先頭文字が英小文字で始められているか。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1N20017変数名ラベル名A文字種は半角英数字と追加文字種のみであること。ラベル名に半角英数字と追加文字種以外の文字種が使用されていないか。
K1N20018変数名ラベル名Aラベル名の英文字はすべて小文字であること。ラベル名の英文字がすべて小文字で記述されているか。
K1N30001メソッド名共通A文字種は半角英数字と追加文字種のみであること。メソッド名に半角英数字と追加文字種以外の文字種が使用されていないか。
K1N30002メソッド名共通A先頭文字は英小文字で始められていること。メソッド名の先頭文字が英小文字で始められているか。
プロジェクトの利用開発ツールが「Apworks」の場合、先頭または末尾に_,$ (アンダーバー カンマ ダラー)があるものは自動的にチェック対象外となる。
K1N30003メソッド名共通A2つ以上の単語を使用する場合は、2つめ以降の単語の先頭文字が大文字であること。チェック機能なし。
K1N30004メソッド名共通A変数を V とする属性を、取り出す (get) 及び設定する (set) メソッドは、 getV 及び setV という名前とする。設定する (set) メソッドに引数があるか、取り出す (get) メソッドで戻り値を返しているか。
K1N30005メソッド名共通Abooleanプロパティへの参照メソッドは、isXXX ()となっていること。boolean型を戻り値とするメソッドの名前がisで開始しているか。
K1N30006メソッド名共通A長さを返すメソッドについては、クラスjava.lang.String内に存在するように、lengthという名前であること。チェック機能なし。
K1N30007メソッド名共通Aオブジェクトを特定のフォーマット F に変換するメソッドは toF という名前とする。チェック機能なし。

元のページへ戻る

ページの先頭へ

パッケージ規約
規約コード分類重要度規約内容チェック内容
K1P10001共通A作成されるすべてのクラスは、「パッケージ名先頭、業務区分、資産区分 (jp.co) 」というパッケージに収められていること。指定されたパッケージに納められているか。

元のページへ戻る

ページの先頭へ

ここからサイト内共通メニューです

Copyright FUJITSU

ページの終わりです