あるソースを開いたところ下記のようなヘッダコメントが有りました。
/****************************************
* Outline :
* Description :
* Type :
* Args :
* Note :
* Date :
* Update :
*****************************************/
ここで、質問なのですが、
FUNCTION BFN_INS( nErrCd OUT NUMBER
,vcErrStr OUT VARCHAR2
) RETURN BOOLEAN;
という関数があった場合、上記のコメントに記述すべき内容は何になるでしょうか?
No.1ベストアンサー
- 回答日時:
/****************************************
* 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:失敗
以上、宜しく御願いいたします。
No.3
- 回答日時:
No.1お礼への回答。
> この関数の返り値が何を示すかもここに記述すればよいのですよね?
その通りです。関数値として返される内容の詳細説明になります。
パラメータ側に返される内容はArgs:の項目で説明します。
No.2
- 回答日時:
書くべき内容は既に回答がでているようですが...
こういう質問をする人がいるということは、英語ではなく日本語で書かないと駄目ということですね(あるいはもっと根本的な問題かも)。
実際にそのソースを触らないといけない人が読めないコメントは無意味ですから。
お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!
似たような質問が見つかりました
- PHP コメント機能に返信欄を矢印で追加したい 1 2022/05/09 21:17
- PHP PHPの構文で間違えが分からない 5 2022/07/11 16:38
- JavaScript 1日1回引けるJavaScriptおみくじについて 1 2022/12/12 22:28
- MySQL php テーブルを作れない 2 2022/11/17 18:22
- PHP php テーブルが作成できない 1 2022/11/17 23:41
- PHP SQLとPHPの連結方法がわからないのでアドバイスお願い致します 1 2022/07/12 12:16
- gooブログ gooブログへのコメント投稿について 1 2023/05/21 03:52
- JavaScript 正規表現について質問です。条件に合う場合はtrueを返したい 3 2022/10/06 23:02
- その他(パソコン・スマホ・電化製品) ワードでテキストボックス内の文字を連動させない方法 2 2023/02/09 16:56
- 日本語 問題: A:トイレにだれ___いませんか。その2 1 2023/03/12 22:01
このQ&Aを見た人はこんなQ&Aも見ています
関連するカテゴリからQ&Aを探す
おすすめ情報
このQ&Aを見た人がよく見るQ&A
デイリーランキングこのカテゴリの人気デイリーQ&Aランキング
-
HTMLメールを送りたい
-
jsファイルの中身を確認したい…
-
Dreamweaverのコードカラーが黒...
-
IEでテキストの文字が一部だけ...
-
VBAで#Regionに変わるものは無...
-
コメントが閉じてないというエ...
-
HTMLメール内のコメント
-
c言語の改修されたソースから改...
-
「MicrosoftVisualBasic6.0 行...
-
縮小版のサムネイルの取得(画像...
-
keylook.exe のソースのありか...
-
ソースの追加行数と変更行数
-
細線化について‥
-
htmlのタブの色変更について
-
#ifdef多用でソースが見づらい
-
レストラン、英語のメニュー表記
-
Excelで、社外秘(閲覧のみ)と...
-
HTMLからフォルダを開きたい
-
googleドライブで、PDFファイル...
-
プログラムについて。
マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング
-
レストラン、英語のメニュー表記
-
VBAで#Regionに変わるものは無...
-
Dreamweaverのコードカラーが黒...
-
ソースの追加行数と変更行数
-
#ifdef多用でソースが見づらい
-
JSPの実行結果をHTMLに変換
-
VBAでhtmlソースから特定の文字...
-
画像と文字が重なって表示される。
-
VB詳しい方
-
「MicrosoftVisualBasic6.0 行...
-
ソースの表示を無効にする方法。
-
htmlのタブの色変更について
-
【VB.NET】WebページのDOMソー...
-
c言語の改修されたソースから改...
-
Visual Source Safe?
-
VisualStudio2010でデバッグソ...
-
COBOLのCALL文について
-
google Map APIの使い方
-
HTMLのソースを文字化けさせる...
-
phpとaspの違い? 実力の違い?
おすすめ情報