プログラム時のヘッダコメントについて

あるソースを開いたところ下記のようなヘッダコメントが有りました。

/****************************************
* Outline :
* Description :
* Type :
* Args :
* Note :
* Date :
* Update :
*****************************************/

ここで、質問なのですが、
FUNCTION BFN_INS( nErrCd OUT NUMBER
,vcErrStr OUT VARCHAR2
) RETURN BOOLEAN;
という関数があった場合、上記のコメントに記述すべき内容は何になるでしょうか？

No.1 ベストアンサー 回答者： koma1000nin 回答日時： 2005/10/31 17:38

/****************************************

*　Outline　　 : 本関数は………の処理を行なう
*　Description : ――もうすこし詳細な説明を書く
*　Type　　　　: BOOL
*　Args　　　　: nErrCd OUT NUMBER
*　　　　　　　　――ここに引数NUMBERの説明を書く
*　　　　　　　　vcErrStr OUT VARCHAR2
*　　　　　　　　――ここに引数VARCHAR2の説明を書く
*　Note　　　　: ――使用上の注意を書く
*　Date　　　　: ――最初のバージョン完成日
*　Update　　　: ――更新日付1と更新理由1および更新者前1を書く
*　　　　　　　　――更新日付2と更新理由2および更新者前2を書く
*　　　　　　　　――更新日付3と更新理由3および更新者前3を書く
*　　　　　　　　――　…
*****************************************/
"Update"は更新経歴になりますので、変更の都度書き加えていきます。

この回答へのお礼

早速のご回答有難うござました。
参考になりましたが、ひとつ質問があります。
------------------
Type　　　　: BOOL
------------------
とありますが、この関数の返り値が何を示すかもここに記述すればよいのですよね？
ex)Type　　　　: BOOL　true:成功
　　　　　　　　　　　 false：失敗

以上、宜しく御願いいたします。

お礼日時：2005/10/31 22:09

No.3 回答者： koma1000nin 回答日時： 2005/11/01 12:51

No.1お礼への回答。

> この関数の返り値が何を示すかもここに記述すればよいのですよね？
　その通りです。関数値として返される内容の詳細説明になります。
　パラメータ側に返される内容はArgs:の項目で説明します。

この回答へのお礼

度重なるご回答ありがとうございました。
大変参考になりました。

お礼日時：2005/11/01 13:15

No.2 回答者： jacta 回答日時： 2005/10/31 17:44

書くべき内容は既に回答がでているようですが...

こういう質問をする人がいるということは、英語ではなく日本語で書かないと駄目ということですね（あるいはもっと根本的な問題かも）。
実際にそのソースを触らないといけない人が読めないコメントは無意味ですから。