関数の説明を記載する場所について困っています。
公開関数のプロトタイプをまとめたヘッダファイルに関数の説明を記載するべきか
それとも、関数の実体があるソースファイルに記載するべきか迷っています
どちらも書けばいいのでしょうが2重管理になってしまうため大変そうです
ここでいう関数の説明とは
処理の概要や、引数の説明、返り値の説明などのことです
ヘッダファイルは公開するため、関数の説明記載は必須と感じています
一方、ソースファイルにもソースの可読性やメンテナンスの際の情報として
関数の説明記載は必要だと感じています
一般的には（あるいは実際の開発では)どのようにして
この問題を解消しているのでしょうか
No.1
1184
80
50pt
個人での開発か、会社などでの開発かで違ってきます。
個人なら自分が解ればいいので自分の好みで書いて構いません。
業務での開発の場合は、会社のコーディング規約に従います。
規約は絶対なので、嫌でも従うしかありません。
私の周りではソースの直前にコメントを入れるのを好む人が多いです。
No.1
118480
ここでベストアンサー
50pt
個人での開発か、会社などでの開発かで違ってきます。
個人なら自分が解ればいいので自分の好みで書いて構いません。
業務での開発の場合は、会社のコーディング規約に従います。
規約は絶対なので、嫌でも従うしかありません。
私の周りではソースの直前にコメントを入れるのを好む人が多いです。
ありがとうございます
参考になりました
No.2
1376156
50pt
業務なら指示に従わないといけませんが、個人なら自由です
一般的に下記のようなコメントが良いとされています
http://d.hatena.ne.jp/eel3/20090811/1249977594
ありがとうございます
参考になりました
Yo
2014/02/11 19:43:40
1
1
1
1
1
5
5
QUWE
tea_cup
しおり
ありがとうございます
2014/02/12 00:18:26参考になりました