関数ヘッダ？

｛コメントで関数の働きや、引数や戻り値（＝関数の返す値）これらの関数を説明するコメント文を関数ヘッダと読んだりもします。｝
とネットでは書いてあったのですが実際にはどんな感じで書くのかよくわかりません。そしてこれをどこに書けばいのでしょうか？

例としてはこんな感じですか？（多分というか絶対間違ってると思いますが）　関数ヘッダの記述は自由でいいと聞きました。
：関数ヘッダ
関数名　:　main
　　型　　：型の動きを書く　　　
　　引数　　:　引数の動きを書く
　　戻り値　:　0
　　履歴　：名前　　修正内容　日付

No.2 ベストアンサー 回答者： asuncion 回答日時： 2008/04/17 09:32

> そしてこれをどこに書けばいのでしょうか？

よくあるのは、当該関数定義の直前でありましょう。

// 関数名　:　hoge
// 　　型　　：型の動きを書く　　　
// 　　引数　　:　引数の動きを書く
// 　　戻り値　:　0
// 　　履歴　：名前　　修正内容　日付
int hoge(int n, char *c)
{
// ここにhoge関数の実体を書く
}

この回答へのお礼

参考になりました　ありがとうございます。

お礼日時：2008/05/03 00:51

No.1 回答者： MrBan 回答日時： 2008/04/17 08:27

プロジェクト毎のルールなどがなければ、

自由なフォーマットでかまわないと思いますが、
たとえば

/// @brief メイン関数
/// メイン関数についての説明
/// @param[in] argc 引数の説明
/// @arg 1 引数がない
/// @param[in] argv 引数の説明
/// @retval 0 処理が成功した
/// @retval !0 処理が失敗した

等の形式にしておくと、"Doxygen"というツールで、
後から自動的に関数仕様などのドキュメントが生成できて
便利かと思います。
"Doxygen"や"JavaDoc"について調べてみてください。

この回答へのお礼

そんなのもあるんですね　知りませんでした
さっそく調べてみます。

お礼日時：2008/05/03 00:52