- 1 名前：デフォルトの名無しさん [03/10/05 23:34]
- おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
- 596 名前：デフォルトの名無しさん mailto:sage [2008/05/26(月) 17:33:49 ]
- libiconvって書いてあるじゃん。
エラーメッセージぐらい読めるようになったら？
- 597 名前：595 [2008/05/26(月) 18:28:33 ]
- >>596
ありがとうございます。
iconv.lib,iconv.hがdoxygenのソース内に入っていたのでこれで良いのかと思っていました。
Libiconvをコンパイルしたものと差し替えたら、コンパイルが通過して下記ファイルが出来ました。
doxygen.exe
doxytag.exe
- 598 名前：ura2ch.czsoftbank219174032071.bbtec.neta.net mailto:グロ [2008/05/26(月) 18:33:08 ]
- guest/guest
- 599 名前：デフォルトの名無しさん [2008/05/28(水) 23:41:27 ]
- 開発の人間なら仕様書を云々言う前に
ソース内のコメントをちゃんと書け！
と思う、インフラ屋は俺だけではないはず。
特にリリース後の修正箇所に対して正確な
コメントが書かれているソースが本当に少ない。
頼むから引数のコメントくらい、まともに書いてくれ・・・・
- 600 名前：デフォルトの名無しさん mailto:sage [2008/05/30(金) 04:18:14 ]
- 変数名自体を説明にするしかない
- 601 名前：デフォルトの名無しさん [2008/05/30(金) 13:08:41 ]
- システムハンガリアンを止めて、アプリケーションハンガリアンにする。
- 602 名前：デフォルトの名無しさん mailto:sage [2008/05/31(土) 00:23:06 ]
- >>599
> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。
これはコミットログやChangeLogの役目だろう
- 603 名前：デフォルトの名無しさん [2008/05/31(土) 13:13:14 ]
- > これはコミットログやChangeLogの役目だろう
ソース内のロジックとコメントは分業してるってこと？
ロジックとそのコメント内容が一致してないから
障害対応してるときに頭からソースを読まなければ
ならないってこと。
そして、修正したPGはすでにいないことが多い・・・・
- 604 名前：デフォルトの名無しさん [2008/05/31(土) 17:32:04 ]
- コメントとソースを同じくらい価値があるものだと考えるのはいいが
コメントとソースを同じように扱ってはいけないだろ
- 605 名前：デフォルトの名無しさん [2008/05/31(土) 18:51:02 ]
- そこまでコメントに期待してないよ。
ただ最初にも書いたけど、表題部の
プログラム名や用途、引数説明すら
まともに書いてないソースが多すぎる
からカキコしただけだ
- 606 名前：デフォルトの名無しさん mailto:sage [2008/05/31(土) 19:19:50 ]
- doxyの1.5.6でツリーが文字化けするのって俺だけ？
1.5.5平気なんだけど
- 607 名前：デフォルトの名無しさん [2008/05/31(土) 21:19:45 ]
- ４コマ漫画で８００ページの取扱い説明書
- 608 名前：デフォルトの名無しさん mailto:sage [2008/05/31(土) 22:24:13 ]
- >>603
> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。
これは 「こう修正しました」 っていうコメントのことでしょ？
それはまさにコミットログ等の役割
コードからは読み取れない 「こういう処理です」 っていうのがコメントの役割だと思う
- 609 名前：デフォルトの名無しさん [2008/06/01(日) 01:34:08 ]
- >>608
"「こう修正しました」"は
ソース内の修正(変更)履歴のことを言ってる。
- 610 名前：デフォルトの名無しさん mailto:sage [2008/06/01(日) 01:53:13 ]
- >>609
そりゃあSCMがない時代の苦肉の策でしょ
- 611 名前：デフォルトの名無しさん mailto:sage [2008/06/01(日) 09:06:34 ]
- >>609
バージョン管理使おうぜ
- 612 名前：デフォルトの名無しさん [2008/06/01(日) 11:47:08 ]
- >610,611
今、休出でVSS見てるけど、コミットログやChangeLogは存在しない。
各ソースのチェックインコメントは全部一緒で"○○○○更改に対する修正"・・・・
ほかに見るとこあれば教えてくれ。
（インフラ側で作ってる基盤モジュールのアップデート履歴のほうが
詳細に記載している。）
- 613 名前：デフォルトの名無しさん mailto:sage [2008/06/01(日) 17:35:45 ]
- >>612
履歴を残そうという意識が作業者に無ければコミットログにも残るわけ無いだろ。
お前んとこのローカルな事情だな、それは。
で、一般的に履歴を残すんならどっちかというとコミットログのほうが適切という話。
- 614 名前：デフォルトの名無しさん mailto:sage [2008/06/01(日) 17:43:21 ]
- >>612
コミットログはチェックインコメントと同じ意味
ツールが違うと用語が違う
チェックインコメントが全部一緒だと無意味だと感じませんか？
チェックインコメントは修正内容を記録するのにうってつけだと思いませんか？
- 615 名前：デフォルトの名無しさん mailto:sage [2008/06/01(日) 17:49:07 ]
- ソースに履歴コメントされても探すのが大変だし。同時に変更したファイルの関連や前後関係も把握するのも正確に記載するのも困難。
コミットログならすぐ探し出せる。コメント漏れがあっても差分を見つけられる。
コミットログに情報がないというのは、結局コメントの入れ方、運用の問題でしょ。
- 616 名前：デフォルトの名無しさん [2008/06/01(日) 19:27:14 ]
- ソースが動かないというのは、結局プログラムの書き方、プログラミングの問題でしょ
みたいな感じに見えた
- 617 名前：デフォルトの名無しさん mailto:sage [2008/06/02(月) 15:25:20 ]
- 【コメント】doxygen【コンソメ】
pc11.2ch.net/test/read.cgi/tech/1212144627/
- 618 名前：デフォルトの名無しさん [2008/07/27(日) 04:43:22 ]
- doxygenの話題は禁止
- 619 名前：デフォルトの名無しさん [2008/08/23(土) 14:10:15 ]
- www.hotdocument.net/
じゃだめかな。
- 620 名前：デフォルトの名無しさん mailto:sage [2008/08/23(土) 18:05:57 ]
- これはひどい
- 621 名前：デフォルトの名無しさん [2008/11/17(月) 15:02:59 ]
- doxygen,hotdocument,visio
どれがいいだろうか・・・
C++Builder2007なんだけど。どれ対応してるかもまだ調べてないんだ。
とりあえず・・・探すか。
|
 |
