- 1 名前：デフォルトの名無しさん [03/10/05 23:34]
- おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
- 572 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 03:18:04 ]
- >>571
落ち着いてジックリ読んでみな。
- 573 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 10:43:42 ]
- >>566
そう言う所は、得てして「うちはどこそこの仕事をしているんだ」って妙な自負があるから
こっちが何を書いてもクレームつけるよ。謝罪の電話があっただけでもましな方かも。
# うっかりしていると、同じドキュメントを「概要」と「詳細」と「解説」の3バージョン作る羽目になったり。
- 574 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 13:11:38 ]
- これはいい勉強になるスレ
- 575 名前：デフォルトの名無しさん mailto:sage [2008/05/01(木) 21:02:41 ]
- >>571
ドキュメントは読めるようになったほうがいいよ。人に
頼ることなく進む力がぐんと増える。(ドキュメントに
頼る時点で、というのは無しで)
どうしたらいいかと言われると解答に困るんだけど、
日頃から疑問に思ったことがあれば、まずドキュメントに
目を通すという習慣をつけてみたらどうだろう。
java でプログラミングしてて分からないことがあったら
まず javadoc を当たってみて、それでも分からなければ
ぐぐってみたりとか。
ツールのインストールの時も、まずは付属ドキュメント
(README, INSTALL みたいなやつ) に目を通すとか。
- 576 名前：デフォルトの名無しさん mailto:sage [2008/05/02(金) 10:31:47 ]
- それ、「～ほうがいいよ」ってレベルじゃなくて、「～できなきゃダメ」のレベルだと思う。
- 577 名前：デフォルトの名無しさん mailto:sage [2008/05/03(土) 13:36:57 ]
- >>546
遷移図は全体を出さずに、
ほげをするとBになります
A→B
ここでげほをするとCになります
A→B→C
ここでほれをするとAになり、やりなおしできます
A→B→C┐
←──┘
まあなんだ、たぶん図は崩れたと思うけど、インクリメンタルに
説明と共に図を成長させると理解してもらいやすい。
パワポのアニメで説明するとわかったきになるのに、
紙に出した同じ資料がわかりにくいのも同じ理由だと思う。
- 578 名前：デフォルトの名無しさん mailto:sage [2008/05/06(火) 04:58:29 ]
- >>572
>>575
遅くなったけど、ありがとう。
疑問を持ったら人に聞くクセをなくすように
がんばります。
- 579 名前：デフォルトの名無しさん [2008/05/08(木) 17:47:02 ]
- 今度開発の仕事やらせてもらう事になりました。
その前に勉強として、仕様書作ってプログラム作れって上司から
言われました。
プログラムは作ったことあるんですが、仕様書なんて作ったことありません。
常識的に考えたら、基本設計書、概要設計書、コード設計書とか全部作るべきでしょうか？
- 580 名前：デフォルトの名無しさん mailto:sage [2008/05/08(木) 20:27:21 ]
- 上 司 に 聞 け
- 581 名前：579 [2008/05/08(木) 23:52:12 ]
- >>580
言葉足らずですみません。
仕様書って何の事か聞いたんですが、自由に作っていいって言われたんです。
自由に作れと言われたら基本的な概要、機能とか画面構成など書けば仕様書としては
成り立つんだと思うんですが、いかんせん初めての経験なのでどのように書いたらいいか
わからないんですよね。
社会人の常識として設計書の本読んで基本設計書、概要設計書
など全ての設計書を作るのが妥当なのかという質問です。
- 582 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 00:08:07 ]
- 単なる練習プログラムなんだから概要からでいいんじゃね
- 583 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 03:44:01 ]
- 上司乙ｗ
- 584 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 08:08:02 ]
- >>581
疲れたので途中で止めとくけど、こんな感じで読める読み物を作ればおけ。
ゴールの定義
・どういう背景があり（どういう歴史があり何で困っていたのか）
・何を実現したいと考えています（作ったものを使うことで得られると期待される効果のこと）
・このために何々をするものを作ることにしました
全体構造
・大きな制約条件として～がある中で（納期、コスト、現状からくる技術�%A
- 585 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 08:09:41 ]
- あれ？途中で切れてしまった・・・
書き直すもの疲れたので諦めるすまん>>581
- 586 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 09:40:43 ]
- 骨組みでこの程度がわかれば良い。
・なんで作ったのか
・それを使ってどういう効果が期待できるか
・必要とする環境
・入力は何か
・出力は何か
競合するプログラムが既にある場合を除いて、
最初はどういう機能がとか、画面が云々とかは不要。
必要だといわれたら付け足していけば良いはず。
読む側にとってどうでもよさそうな事は極力避ける事。
つーか多分作ったのを後で添削するのが
意図なわけだから、あまり時間掛けると嫌われるぞ。
- 587 名前：581 [2008/05/09(金) 16:21:25 ]
- >>586
入力、出力ってどういう意味ですか？
A4用紙一枚にまとめるのは変でしょうか？
- 588 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 16:40:36 ]
- >>587
入力も出力もないプログラムは役に立たないだろう
記述が必要十分なら一文字にまとまっていても構わないぞ
- 589 名前：581 [2008/05/09(金) 17:00:35 ]
- >>588
もしデータベースを扱うプログラムだったら、
どのようなデータを登録して（入力）、どのような形で表示するか（出力）
簡単に言えばこのような事でしょうか？
- 590 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 20:04:08 ]
- 電卓のイメージなら簡単だろ？
ユーザーが入力して、プログラムがそれを計算する。（出力）
- 591 名前：デフォルトの名無しさん mailto:sage [2008/05/10(土) 01:11:34 ]
- 上司から言われたことの真の目的を明確にして、その目的を達成するためのプロセスや成果物を決めたらどうだろうか？
社会人の常識とかじゃなくて、目的から考えた方がよいのでは
- 592 名前：デフォルトの名無しさん [2008/05/10(土) 10:46:22 ]
- クラスの仕様の概要って、どこまでが概要ですか？
- 593 名前：デフォルトの名無しさん mailto:sage [2008/05/10(土) 10:52:50 ]
- >>592
クラス仕様の詳細じゃない部分
- 594 名前：デフォルトの名無しさん mailto:sage [2008/05/10(土) 11:23:40 ]
- >>592
・そのクラスの責任範囲と全体の中での役割
・超簡単なサンプル使用例
・データの流れと関与する主要APIを図示したもの（ポイントとなるクラスの場合）
これが１ページで欲しい所。
- 595 名前：デフォルトの名無しさん [2008/05/26(月) 16:40:33 ]
- doxygenについて質問したいのですが、専用スレが無いようなのでこちらでさせてください。
PC:Windows XP
コンパイル方法:Visual Studio 2005のコマンドプロンプト上で、下記の命令をする
make msvc
C:\doxygen1.5.5 に doxygen1.5.5.src.tar.gz を解凍した中身を置きました。
C:\doxygen1.5.5\src のソースをいじって、コンパイルしましたがエラーが出てしまいます。
エラー内容
----
link /NOLOGO /LIBPATH:..\lib /SUBSYSTEM:console /OUT:..\bin\doxygen.exe
@C:\DOCUME~1\AA\LOCALS~1\Temp\nm2E.tmp
～
doxycfg.lib(portable.obj) : error LNK2019: 未解決の外部シンボル __imp__libiconv_open が関数 "void * __cdecl portable_iconv_open(char const *,char const *)" (?portable_iconv_open@@YAPAXPBD0@Z) で参照されました。
～
..\bin\doxygen.exe : fatal error LNK1120: 外部参照 5 が未解決です。
NMAKE : fatal error U1077: 'link' : リターン コード '0x460'
----
doxygenのソースのコンパイルは、下記以外に必要なものはありますか？
・Active perl
・GnuWin32のFlex
・Qt
・VC2005
・Microsoft Platform SDK
- 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なんだけど。どれ対応してるかもまだ調べてないんだ。
とりあえず・・・探すか。
|
 |
