C言語のコメントの書き方について教えてください
関数の説明を記載する場所について困っています。
公開関数のプロトタイプをまとめたヘッダファイルに関数の説明を記載するべきか
それとも、関数の実体があるソースファイルに記載するべきか迷っています
どちらも書けばいいのでしょうが2重管理になってしまうため大変そうです
ここでいう関数の説明とは
処理の概要や、引数の説明、返り値の説明などのことです
ヘッダファイルは公開するため、関数の説明記載は必須と感じています
一方、ソースファイルにもソースの可読性やメンテナンスの際の情報として
関数の説明記載は必要だと感じています
一般的には（あるいは実際の開発では)どのようにして
この問題を解消しているのでしょうか
※ 有料アンケート・ポイント付き質問機能は2023年2月28日に終了しました。
ログインして回答する
ベストアンサー
-
bg5551
満足50pt
個人での開発か、会社などでの開発かで違ってきます。
個人なら自分が解ればいいので自分の好みで書いて構いません。
業務での開発の場合は、会社のコーディング規約に従います。
規約は絶対なので、嫌でも従うしかありません。
私の周りではソースの直前にコメントを入れるのを好む人が多いです。 -
その他の回答
-
エネゴリ
満足50pt
業務なら指示に従わないといけませんが、個人なら自由です
一般的に下記のようなコメントが良いとされています
http://d.hatena.ne.jp/eel3/20090811/1249977594 -
この質問へのコメント
質問の情報
- 登録日時
- 2014-02-11 17:17:57
- 終了日時
- 2014-02-12 00:19:26
- 回答条件
- 1人10回まで
この質問のカテゴリ
この質問に含まれるキーワード
人気の質問
-
法人が物品を購入する際に必要とされる領収証についての話です。10年前などは、宛名を空白にしても問題なか…
匿名質問者
2
-
以前と同じような質問で申し訳ありません。 記事 https://www.projectdesign.jp/201611/college-sports/00…
hayakushinene2
-
朝早く目が覚ます原因はなにかの栄養素が足りないですか？ 夜１２時寝ていつも朝７時に目を覚めますが、最…
iquestion1
-
この髪の長さってなんて名前の長さですか？ロングヘアですか？ …匿名質問者1
1
-
１０年前に購入した３万円のPCが遂に壊れました。 長持ちした方でしょうか？ …
coccinellab21
1
書式例）
//
// 関数名：
//
// 引 数：
//
// 戻り値：
//
// 説 明：
//
// 履 歴：
//
//
ここで重要なのは、この関数のコメントを読めばプログラム仕様書が無くても理解できる様に記述するという事です。
ローカル変数、外部変数、アルゴリズムの簡単な説明はソース内に記述します。
上記の様な関数説明は、個人的に書くソースであれば不要若しくは簡略化できますが、業務で書くソースについては、コーディング規約に基いて記載します。
コーディング規約に関数説明が無い場合は、統一したフォーマットを予め決めておくのがいいと思います。
参考になりました
せっかくコンピュータ使っているのですから、自分たちの役にも立てましょう。
最近の開発現場知りませんが、「コメント部分を比較して更新があったら更新をかける」スクリプトをバージョン管理システムと組み合わせて使えばそんなに大変じゃないです。
ヘッダファイルのコメントを直接書き換えちゃう人には、ルールを教育する必要がありますが。
Doxygen:
http://www.doxygen.jp/