Last Update 2004/01/04

金太郎プロジェクト

２．関数作成時のコメント

関数を作成した場合は以下の順番でコメントを記述すること
※　コメント{}記号はできるだけ使用しないでください。

１．関数名
２．関数の簡単な説明
３．使用例
４．補足(備考)
５．引数説明
６．戻り値説明
７．履歴

以下に例を示します。

//-------- 2002/03/27 ------------------------------------------------//
//  関数名：Cs_ACheck
//  ２つの文字列を比較する
//
//  例：
//    if Cs_ACheck( 'ABC', 'B', 'US' ) = Cns_OK then
//------------------------------------------------------------------//
//  補足：
//------------------------------------------------------------------//
//  引数説明
//    ArgModeの説明
//      U(Upper)....半角文字を英大文字に変換してから比較する
//      L(Lower)....半角文字を英小文字に変換してから比較する
//      S...........２つの文字列の長さが違う場合は短い文字列の長さで比較する
//------------------------------------------------------------------//
//  戻り値
//    Cns_OK(0)
//    Cns_Large(1)  より大きい
//    Cns_Small(-1) より小さい
//------------------------------------------------------------------//
//  履歴：
//    V1998/06/27 : 新規 ???
//    V2002/03/15 : コメント修正
//------------------------------------------------------------------//