- ベストアンサー
関数ヘッダ？
｛コメントで関数の働きや、引数や戻り値（＝関数の返す値）これらの関数を説明するコメント文を関数ヘッダと読んだりもします。｝ とネットでは書いてあったのですが実際にはどんな感じで書くのかよくわかりません。そしてこれをどこに書けばいのでしょうか？ 例としてはこんな感じですか？（多分というか絶対間違ってると思いますが） 関数ヘッダの記述は自由でいいと聞きました。 ：関数ヘッダ 関数名 : main 型 ：型の動きを書く 引数 : 引数の動きを書く 戻り値 : 0 履歴 ：名前 修正内容 日付
- C・C++・C#
- 回答数2
- ありがとう数2
- みんなの回答 （2）
- 専門家の回答
質問者が選んだベストアンサー
> そしてこれをどこに書けばいのでしょうか？ よくあるのは、当該関数定義の直前でありましょう。 // 関数名 : hoge // 型 ：型の動きを書く // 引数 : 引数の動きを書く // 戻り値 : 0 // 履歴 ：名前 修正内容 日付 int hoge(int n, char *c) { // ここにhoge関数の実体を書く }
その他の回答 (1)
- MrBan
- ベストアンサー率53% (331/615)
プロジェクト毎のルールなどがなければ、 自由なフォーマットでかまわないと思いますが、 たとえば /// @brief メイン関数 /// メイン関数についての説明 /// @param[in] argc 引数の説明 /// @arg 1 引数がない /// @param[in] argv 引数の説明 /// @retval 0 処理が成功した /// @retval !0 処理が失敗した 等の形式にしておくと、"Doxygen"というツールで、 後から自動的に関数仕様などのドキュメントが生成できて 便利かと思います。 "Doxygen"や"JavaDoc"について調べてみてください。
お礼
そんなのもあるんですね 知りませんでした さっそく調べてみます。
関連するQ&A
- 関数について
協力お願いします。 ２問あります １問目です。 西暦年yearを引数として受け取り， 閏年かどうかの判定結果を戻り値として返す関数leap_year()を作成せよ． ただし，leap_year()は，閏年の場合は1を返し， そうでない場合は0を戻り値として返すものとする． 提出するプログラムは，関数leap_year()だけでなく， メイン関数main()も含む下記プログラムを完成させる形で作成する。 #include <stdio.h> /* ここに関数leap_year()のプロトタイプ宣言を記述する */ int main() { int i, year[3]; for (i=0; i<3; i++) { printf("西暦年を入力してください"); scanf("%d", &year[i]); if (leap_year(year[i]) == 1) { printf("閏年です．\n"); } else { printf("閏年ではありません．\n"); } } } /* ここに関数leap_year()を定義する */ ２問目です。 mのn乗を計算する関数power()を作成せよ． ただし，関数power()はm,nを引数とし， 戻り値としてmのn乗の値を返すものとする． m,nは，正整数とする．プログラムには， 関数power()だけでなく，m,nを入力し， mのn乗を出力するメイン関数main()を含むものとする． main()は，power()の前に記述すること． また，power()のプロトタイプ宣言も記述すること。 よろしくお願いします。
- 締切済み
- C・C++・C#
- 関数の引数に 値を入れることを 渡す その関数が結
関数の引数に 値を入れることを 渡す その関数が結果を出すことを 返す とか 返り値戻り値 という この認識であっていますか？
- ベストアンサー
- その他（プログラミング・開発）
- C言語 関数について
協力お願いします。 ２問あります。 １問目です。 西暦年yearを引数として受け取り， 閏年かどうかの判定結果を戻り値として返す関数leap_year()を作成せよ． ただし，leap_year()は，閏年の場合は1を返し， そうでない場合は0を戻り値として返すものとする． 提出するプログラムは，関数leap_year()だけでなく， メイン関数main()も含む下記プログラムを完成させる形で作成する。 #include <stdio.h> /* ここに関数leap_year()のプロトタイプ宣言を記述する */ int main() { int i, year[3]; for (i=0; i<3; i++) { printf("西暦年を入力してください"); scanf("%d", &year[i]); if (leap_year(year[i]) == 1) { printf("閏年です．\n"); } else { printf("閏年ではありません．\n"); } } } /* ここに関数leap_year()を定義する */ ２問目です。 mのn乗を計算する関数power()を作成せよ． ただし，関数power()はm,nを引数とし， 戻り値としてmのn乗の値を返すものとする． m,nは，正整数とする．プログラムには， 関数power()だけでなく，m,nを入力し， mのn乗を出力するメイン関数main()を含むものとする． main()は，power()の前に記述すること． また，power()のプロトタイプ宣言も記述すること。 よろしくお願いします。
- 締切済み
- C・C++・C#
- VB 関数
初めまして。 VB初心者なので，簡単な質問なのかしれませんが御願いします。 C言語で, int main (void) 戻り値の型 関数名 戻り値なし と書きますが，これと同じ意味を持つプログラムをVBで書くとどのようになりますか？ 関数の作り方がまだわかってないので教えていただけますか？ 宜しく御願いします。
- ベストアンサー
- Visual Basic
- GDBでCプログラムの関数の引数を変更したい
関数の引数の値を書き換えたいです。 DGBのx/iコマンドでアッセンブラをみて レジスタに格納された引数の値を書き換えようと考えています。 このコマンドで書き換えたい関数の＄ebpを見て書き換える予定です。 引数を書き換えたい関数の戻り値が構造体であるかないかで、$ebpからのアドレスの位置が変更されてしまいます。 他に格納されている関数の引数のアドレスが１つに固定できる方法はないでしょうか？ できないとしたら、条件で関数の戻り値が構造体かどうかの判断はどこでつければよいでしょうか？
- 締切済み
- Linux系OS
- main関数の戻り値
Ｃ言語のmain関数の戻り値はint型ですよね。 私もそういう決まりだと思って守ってきました。 しかし、「mainが戻り値を返すって、どこに返すの？」ということが、私は理解できていません。 私が調べたところでは、「ホスト実行環境」という言葉がこの問題に関係あるようですが、この言葉の意味はよくわからないですし、似た言葉で「ホスト環境」ということばがあるのですが意味も関係もわかりません。 これらは、ＯＳとは違うと思うんですが、自信はありません。 それでも、ない知識を振り絞っていろいろ考えてみると、次のようなことらしいのですが、正しいでしょうか。 ・ＯＳはプログラムの実行に先立ちホスト実行環境を作る。 ・静的記憶域のオブジェクトを初期化するのはホスト実行環境である。 ・関数が、main関数を呼ぶことは可能である。（以下では、main関数が関数から呼ばれる場合は除く。） ・main関数を呼ぶのは、ホスト実行環境が行なう。 ・main関数の中のreturnによってプログラムが終了するのと、exit関数でプログラムが終了することに違いはない。 ・main関数の戻り値は、ホスト実行環境に返される。 ・returnによってホスト実行環境に返される値は、int型である限りなんでもよい。 ・exitによってホスト実行環境に返される値は、int型である限りなんでもよい。 ・必ずexitで値が返されるならば、main関数の中にreturnはなくてもよい。 main関数からの戻り値をどうしようと構わないんだと思うんですが、皆さんの経験の中で、実例としてこういうふうに使われる、というのは何かないのでしょうか。 （ホスト実行環境に値が返される、といっても無視するのでは意味はないと思うのです。 その値の使用例としては、 ０が返ってくると「プログラムは正常終了しました。」と表示するとか、０以外の値が返されると別のプログラムが走るとか、 そういうことだと思うんですが。）
- ベストアンサー
- C・C++・C#
- ヘッダファイルに関数本体を書き込めないのか?
こんにちは。 現在WindowsVistaでCおよびC++を使ってプログラミングを行っています。 最近になって思ったのですが、普通、ヘッダファイルに記述する内容は、 ・関数のプロトタイプ ・クラスのメンバ関数を除いた部分(いわゆる「クラスの骨格」) ・マクロ といったものだと言われています。 そして、関数の実態やクラスのメンバ関数などは、 別のソースファイルに記述するように言われています。 なぜ、ヘッダファイルに関数の実態や、クラスのメンバ関数を記述するべきではないでしょうか? あるいは、プログラムの内容に応じて、関数やクラスの内容を、 ヘッダファイルにまるごと記述してもよい場合と悪い場合があるのでしょうか? こういった事について、何か御存じの方がいらっしゃれば、是非アドバイスをお願い致します。 (難しい問題なので、なるべく詳しい説明を頂けると、大変助かります。) ちなみに、関数やクラスのメンバ関数も一緒に、クラスの内容をまるごとヘッダファイルに記述しても、 今までの所、全く問題なく動作しています。 例えば、以下のようなプログラムは、何の問題もなく動作します。 ●main.c ____________________________________________________________ #include <stdio.h> #include <stdlib.h> #include <ctype.h> #include <string.h> #include "func.h" void main(void) { char str[80]; puts("文字列を入力せよ"); gets(str); func(str); } ____________________________________________________________ ●func.h ____________________________________________________________ #include <stdio.h> #include <stdlib.h> #include <ctype.h> #include <string.h> void func(char *p) { puts("入力された内容は以下の通り。"); while(*p) putchar(*p++); } ____________________________________________________________
- ベストアンサー
- C・C++・C#
- GCCで関数の引数が渡らない
gcc Ver2.9 でSH-2の開発をしています。 通常に関数を作成し、引数を渡しているのですが、引数が渡らないという現象が起きています。 現象は、 １．引数はポインタではなく値渡しである ２．引数の値が０の時だけ正しく渡らない。値が０以外の時は正常にわたる ３．引数の型は一致している ４．引数は複数あるが、後半のいくつかがだめ（何個とまでは詳しく調べていません） ５．ある特定の関数の特定の呼び出しのみがだめで全てだめというわけではない ６．コンパイルオプションに -m2 をつけるとだめだが、-m1 オプションだと問題ない ７．最適化オプションをなくしても同じだった といった状況です。 上記５からある特定の記述方法とか順序になるとだめになるのではないかといろいろ試してみたのですが見つけられません。６から記述方法に誤りがあるとも考えにくい状況です。コンパイラのバグといって片付けていいものなのかどうかです。どなたか同じような経験をされた方はいらっしゃいませんか。また関数呼び出しの場合、コンパイラがどうやって引数を渡すかご教授願えませんか。
- 締切済み
- C・C++・C#
- main関数の事についてお聞きします。
Windowsのプログラムを書くとき、下のようにキッチリ戻り値や引数を書かなくてはならないのに int WINAPI WinMain( HINSTANCE hInstance, // 現在のインスタンスのハンドル HINSTANCE hPrevInstance, // 以前のインスタンスのハンドル LPSTR lpCmdLine, // コマンドライン int nCmdShow // 表示状態 ); C言語で書かれたプログラムは int main(int argc, char *argv[]) ではなく、 int main(void) や void main(void) または int main() や main() だけのモノなど、 いろいろです。 main関数は、関数なのに戻り値や引数を省略して書ける仕様なのは、なぜなのか？ ちょっと疑問に思ったのでこちらにお尋ねしました。
- ベストアンサー
- C・C++・C#
お礼
参考になりました ありがとうございます。