No.2ベストアンサー
- 回答日時:
> そしてこれをどこに書けばいのでしょうか?
よくあるのは、当該関数定義の直前でありましょう。
// 関数名 : hoge
// 型 :型の動きを書く
// 引数 : 引数の動きを書く
// 戻り値 : 0
// 履歴 :名前 修正内容 日付
int hoge(int n, char *c)
{
// ここにhoge関数の実体を書く
}
No.1
- 回答日時:
プロジェクト毎のルールなどがなければ、
自由なフォーマットでかまわないと思いますが、
たとえば
/// @brief メイン関数
/// メイン関数についての説明
/// @param[in] argc 引数の説明
/// @arg 1 引数がない
/// @param[in] argv 引数の説明
/// @retval 0 処理が成功した
/// @retval !0 処理が失敗した
等の形式にしておくと、"Doxygen"というツールで、
後から自動的に関数仕様などのドキュメントが生成できて
便利かと思います。
"Doxygen"や"JavaDoc"について調べてみてください。
お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!
似たような質問が見つかりました
- C言語・C++・C# C言語初心者 ポインタについて、お助けください、、 2 2023/03/15 23:50
- JavaScript useStateの分割代入について 1 2022/05/06 10:02
- JavaScript カラーミーショップのsectionループ内で、[引数][戻り値]ありの関数的な処理を行いたいです。 1 2022/05/07 19:39
- C言語・C++・C# C言語初心者です、、、お助けください 2 2023/03/14 20:08
- Excel(エクセル) 数式→数値固定する方法ありますか? 5 2023/06/18 15:22
- 数学 複素関数と実関数のテーラー展開の違いについて 1 2022/08/09 06:18
- 数学 関数の極値と微分係数の関係について 6 2023/04/23 14:35
- C言語・C++・C# 絶対ち 5 2022/10/09 17:36
- 数学 【 数Ⅰ 2次関数 】 問題 関数y=mx²+4x+m-3において,yの値が 常に負であるという条件 2 2022/10/01 15:08
- 文学・小説 横書き小説の数字の表記について 1 2023/01/15 22:05
関連するカテゴリからQ&Aを探す
おすすめ情報
デイリーランキングこのカテゴリの人気デイリーQ&Aランキング
-
VBAでExcelのヘッダーに文字列+...
-
HTTPヘッダの大きさ
-
HTTP 200 OKの後のリダイレクト?
-
perlでHTTP Request Headersの...
-
MTUについて(Ethernetヘッダ)
-
ヘッダのinclude順
-
ルータでのMTU、MSS設定値の検...
-
自作ヘッダファイルについて (C...
-
リストコントロールの列幅を固...
-
LinuxでRTPヘッダを作りたいの...
-
エクセルで 自動的に◯や数字を...
-
ファイルをディレクトリ分配の...
-
月の第一週とは
-
DBを10件毎に表示ページング...
-
apacheでPerl CGIが作動せず、5...
-
曜日を求めるプログラムはどう...
-
C言語でわからないところがが...
-
JAVASCRIPT禁止でのボタン&リン...
-
クライアントのIPとマシン名を...
-
週2回のペースって だいたい何...
マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング
-
VBAでExcelのヘッダーに文字列+...
-
[C#]ListView一覧表示時の幅設...
-
リストコントロールの列幅を固...
-
ヘッダのinclude順
-
AccessVBAで「このフィールドに...
-
HTTPヘッダの大きさ
-
LinuxでRTPヘッダを作りたいの...
-
バイナリファイルのアップロー...
-
Content-type: text/htmlが表示...
-
SpreadDesignerの列ヘッダ
-
file_get_contents でリダイレ...
-
TCPヘッダのチェックサム算出方法
-
あれれ、クッキーが機能しませ...
-
関数ヘッダ?
-
SSL環境でオートコンプリートを
-
perlでHTTP Request Headersの...
-
ログイン後・・・
-
メールをPDF化する際に、ヘッダ...
-
Thunderbirdのフィルタについて
-
レスポンスヘッダとエンティテ...
おすすめ情報