良いドキュメント・マニュアル・仕様書を書くスレ

良いドキュメント・マ ..

608:デフォルトの名無しさん
08/05/31 22:24:13
>>603
> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。

これは「こう修正しました」っていうコメントのことでしょ？
それはまさにコミットログ等の役割
コードからは読み取れない「こういう処理です」っていうのがコメントの役割だと思う

609:デフォルトの名無しさん
08/06/01 01:34:08
>>608
"「こう修正しました」"は
ソース内の修正(変更)履歴のことを言ってる。

610:デフォルトの名無しさん
08/06/01 01:53:13
>>609
そりゃあSCMがない時代の苦肉の策でしょ

611:デフォルトの名無しさん
08/06/01 09:06:34
>>609
バージョン管理使おうぜ

612:デフォルトの名無しさん
08/06/01 11:47:08
>610,611
今、休出でVSS見てるけど、コミットログやChangeLogは存在しない。
各ソースのチェックインコメントは全部一緒で"○○○○更改に対する修正"・・・・
ほかに見るとこあれば教えてくれ。

（インフラ側で作ってる基盤モジュールのアップデート履歴のほうが
詳細に記載している。）

613:デフォルトの名無しさん
08/06/01 17:35:45
>>612
履歴を残そうという意識が作業者に無ければコミットログにも残るわけ無いだろ。
お前んとこのローカルな事情だな、それは。

で、一般的に履歴を残すんならどっちかというとコミットログのほうが適切という話。

614:デフォルトの名無しさん
08/06/01 17:43:21
>>612
コミットログはチェックインコメントと同じ意味
ツールが違うと用語が違う
チェックインコメントが全部一緒だと無意味だと感じませんか？
チェックインコメントは修正内容を記録するのにうってつけだと思いませんか？

615:デフォルトの名無しさん
08/06/01 17:49:07
ソースに履歴コメントされても探すのが大変だし。同時に変更したファイルの関連や前後関係も把握するのも正確に記載するのも困難。
コミットログならすぐ探し出せる。コメント漏れがあっても差分を見つけられる。
コミットログに情報がないというのは、結局コメントの入れ方、運用の問題でしょ。

616:デフォルトの名無しさん
08/06/01 19:27:14
ソースが動かないというのは、結局プログラムの書き方、プログラミングの問題でしょ
みたいな感じに見えた

617:デフォルトの名無しさん
08/06/02 15:25:20
【コメント】doxygen【コンソメ】
ｽﾚﾘﾝｸ(tech板)

618:デフォルトの名無しさん
08/07/27 04:43:22
doxygenの話題は禁止

619:デフォルトの名無しさん
08/08/23 14:10:15
URLﾘﾝｸ(www.hotdocument.net)
じゃだめかな。

620:デフォルトの名無しさん
08/08/23 18:05:57
これはひどい

621:デフォルトの名無しさん
08/11/17 15:02:59
doxygen,hotdocument,visio

どれがいいだろうか・・・
C++Builder2007なんだけど。どれ対応してるかもまだ調べてないんだ。

とりあえず・・・探すか。