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

1 名前：デフォルトの名無しさん [03/10/05 23:34] おまえら、自分で作ったプログラムについての、わかりやすく的確な ドキュメントを書ける自信はあるか？ 仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、 マニュアルや、仕様書などのドキュメントを書く機会は必ずある。 プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。 ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。 だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？ いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、 実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い) 読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。 プログラムに対するドキュメントを、ちゃんとした１作品として、 後世に残せるよう努力すべきだろう。 今一度問う。 おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？ 321 名前：デフォルトの名無しさん mailto:sage [2006/03/32(土) 18:31:53 ] UMLは客に理解してもらうためのもの、 なんて言ってる人はあなた以外に見たことありませんけどw 自分が勝手に銀の弾丸を求めてるだけでしょ？ 銀の弾丸がきっとあるに違いないと無意識に思ってるから ネジ廻しがネジを締めることにしか使えないことに苛立つんだよ。 322 名前：デフォルトの名無しさん mailto:sage [2006/03/32(土) 18:57:02 ] ＞UMLは客に理解してもらうためのもの、 ＞なんて言ってる人はあなた以外に見たことありませんけどw 見聞が狭いんだね。俺は何人か知ってるよ。 見たこともない、とは重傷だな。 323 名前：デフォルトの名無しさん mailto:sage [2006/03/32(土) 20:35:16 ] ダメなドキュメントってあるよね。当たり前のことしか書いてなくて、 ポイントが抑えられてないような。 UMLだろうがワードだろうが、同じ人間が書く限りダメなドキュメントなのは変わらないのが現実 324 名前：デフォルトの名無しさん mailto:sage [2006/03/32(土) 23:02:48 ] ドキュンメント 325 名前：デフォルトの名無しさん [2006/04/09(日) 00:06:13 ] みんなはdoxygenでコメント書くとき Qtスタイルにしてます？JavaDocスタイルにしてます？ 326 名前：デフォルトの名無しさん mailto:sage [2006/04/09(日) 17:17:32 ] JavaDoc スタイル。 Qt ってマイナーだし Qt にするメリットってあるの？ 327 名前：デフォルトの名無しさん mailto:sage [2006/04/09(日) 20:37:45 ] >>320 むつかしく書きすぎ、細かく書きすぎ なんじゃないの？ 328 名前：デフォルトの名無しさん mailto:sage [2006/04/09(日) 21:42:04 ] 言われてみればそうだよな…・。 伝えるだけなら、 紙に手書きしてコピったりスキャナで取り込むなりの方が遥かに敏速。 329 名前：デフォルトの名無しさん mailto:sage [2006/04/10(月) 03:00:04 ] >>319 それこそ本屋にいけば山ほどその手の本があるやん。 成果物が一番はっきり明示されているのはラショナル統一プロセス じゃないの。ISO9001なんかを取得している会社なら社内標準で 成果物が設定されているでしょ。 >>320 オブジェクト指向言語で開発しているなら、それとの親和性の 高さという点から、内部設計はUMLでするのはいい。けど、 要求仕様をユースケースなんかで顧客に見せるやつの気が知れない。 というかそういうやついるのか？俺はずっと前からアンチユース ケース派でそういうことばっかり言っているけど。 330 名前：329 mailto:sage [2006/04/10(月) 03:02:49 ] >>319 それと追記するけど、どんな職場や環境、メンバーのスキルに 合致した魔法の世界標準フォーマットは存在するわけがない。 それぞれに合致したものはそれぞれが苦労して考えるしかない。 参考にするのはいいけど、巷に出回っている開発プロセスを そのままやろうとすると失敗するよ。 331 名前：デフォルトの名無しさん [2006/04/18(火) 15:12:14 ] 質問。 仕様書だけ書いて、それを ベクターみたいに、アップロードして みんなに見せるサイトって、どこかある？ 332 名前：デフォルトの名無しさん mailto:sage [2006/04/18(火) 15:15:33 ] 参考。仕様書相互リンク 良いドキュメント・マニュアル・仕様書を書くスレ pc8.2ch.net/test/read.cgi/tech/1065364445/ 小規模開発では仕様書は作るだけ無駄 pc8.2ch.net/test/read.cgi/prog/1125913671/ AJAX時代の仕様書とは pc8.2ch.net/test/read.cgi/tech/1140766471/ 営業が作った仕様書に pc8.2ch.net/test/read.cgi/prog/1121256149/ 良い仕様書、悪い仕様書、普通の仕様書 pc8.2ch.net/test/read.cgi/prog/1143906019/ プログラマ経験がないのに仕様書を作成 pc8.2ch.net/test/read.cgi/prog/1119776686/ 仕様書の量でしか成果を決められない客 pc8.2ch.net/test/read.cgi/prog/1143878620/ Excelで仕様書を作る会社の奴の数→ pc8.2ch.net/test/read.cgi/prog/1137662854/ 333 名前：デフォルトの名無しさん [2006/04/19(水) 02:18:12 ] Doxygenの質問はここでいいのかな…？ HIDE_UNDOC系のタグをYESにしててドキュメント付けした要素だけ 書き出してるんだけど（もちろんEXTRACT_ALLはNO） \fnとか一行コメントとか付けてない関数を強制的にドキュメントに含めてよ！ って指示するコマンドありますか？ 今は全角空白の一行コメント付けて無理やり出してるんだけど リスト表示のとこで無駄に下に空白ができちゃってみづらいんです （同じページに列挙したいけどわざわざコメント付けしたくない関数ってのがいっぱいある） 334 名前：sage [2006/04/28(金) 11:10:03 ] コーディングは製造であって、 その前に設計仕様書があるべきだと思うんですが、 DoxygenやJavaDocで出したものを、仕様書にするってことは それ以前にモジュール設計仕様書とか無いままコーディング してるんでしょうか？ 335 名前：デフォルトの名無しさん mailto:sage [2006/04/28(金) 12:19:21 ] 中身ダミーで関数名と Doxygen 形式の仕様コメントだけ入れた骨組みをもって設計仕様ではダメなの？ 336 名前：デフォルトの名無しさん mailto:sage [2006/04/28(金) 13:07:44 ] で、実際んな事やってんの?って話だろ 337 名前：sage [2006/04/28(金) 13:21:18 ] >>336 そりゃ、設計代もらってるんだからやりますよ フリーソフトウェアの開発者とかなら話は別ですが… 338 名前：デフォルトの名無しさん mailto:sage [2006/04/28(金) 13:55:57 BE:162918959- ] 鉄面皮で四角四面のウォーターフォール　うぜぇ 339 名前：デフォルトの名無しさん mailto:sage [2006/04/28(金) 17:09:48 ] >>334 >コーディングは製造であって、 違います。 - コーディングは設計作業です - ソースコードは設計成果物です - コンパイル・リンクなどが製造工程になります 340 名前：デフォルトの名無しさん mailto:sage [2006/04/28(金) 17:25:01 ] 不正確でつまんない比喩なんてどうでもいいよ。 341 名前：デフォルトの名無しさん [2006/04/28(金) 21:56:05 ] >>339 幸せだなぁ… そう思ってるうちはコーダーから卒業できんよ 342 名前：デフォルトの名無しさん [2006/04/28(金) 22:45:00 ] 東芝とか日立とかの大手が集まって仕様書の標準作るらしいね。 ２００７年をめどに完成予定とか。 どうなるのかな？ 343 名前：デフォルトの名無しさん mailto:sage [2006/04/29(土) 04:30:26 ] 実行されたプログラムの動作こそが製造だ。 コーディングは、ラインの設計だ。 344 名前：デフォルトの名無しさん mailto:sage [2006/04/29(土) 10:24:49 ] 不正確でつまんない比喩なんてどうでもいいよ。 345 名前：デフォルトの名無しさん mailto:sage [2006/04/29(土) 21:31:40 ] コードコンプリートの メタファの章はよくまとまってるよ 346 名前：デフォルトの名無しさん mailto:sage [2006/05/01(月) 20:45:13 ] Doxygenを実際使ってるプロジェクトってある？ 俺は個人的にちまちまいじってるぐらいです。 みんなに使ってもらうにはやはり雛形を作成するしかないけど どんなのがいいのか思案中。 なにかサンプルと成るものってあります？ 347 名前：デフォルトの名無しさん mailto:sage [2006/05/01(月) 20:49:42 ] >>346 Doxygen 自体 libstdc++ Subversion いっぱいあるよ。 っていうか、雛形なんか要らないと思うけど。 348 名前：デフォルトの名無しさん mailto:sage [2006/05/01(月) 20:54:11 ] Doxygenで悩むのがテンプレート定義しかないヘッダファイルへのコメント そりゃヘッダに実装も書いてあるんだからそこにコメント付けるのが自然かもしれんが 各テンプレートの間にミッチりコメントが詰まってソースコードとして読みづらくなる（困 こういうときってコメントだけの空cppファイルとか作るんですかね？ 349 名前：デフォルトの名無しさん mailto:sage [2006/05/01(月) 20:58:42 ] >>348 Doxygen とか関係なしに、コメント書きすぎなんじゃね？ もしくはコメント書かざるをえない設計とか？ 350 名前：デフォルトの名無しさん mailto:sage [2006/05/01(月) 22:23:54 ] >>349 書きすぎってのはあるかも試練… 対象ユーザーのC++理解度が低い前提で書いてるんで どう使ったらいいかのコード例みたいのもコメントに含んでるんだけど やりすぎかね @defgroup してモジュールの説明とか書き始めるともうコメントだらけですよ 351 名前：デフォルトの名無しさん mailto:sage [2006/05/02(火) 16:26:03 ] サンプルみたいなものが書いてあるならそれはコメントとは呼ばないよ 352 名前：デフォルトの名無しさん mailto:sage [2006/05/05(金) 14:12:41 ] doxygenだと__declspec(property)とかがメソッドとして認識されちまう。 なんかうまい方法ある？ っつーかこんなん使うなって話になりそうな気もするけど 353 名前：デフォルトの名無しさん mailto:sage [2006/05/06(土) 13:39:38 ] >>352 プリプロセッサで消せば？ こんな感じで。 #ifndef __MSC_VER 　#define __declspec(arg) /* ignore */ #endif 354 名前：デフォルトの名無しさん mailto:sage [2006/05/11(木) 01:18:44 ] おぉ？ www.doxygen.jp/ 355 名前：デフォルトの名無しさん [2006/06/11(日) 22:16:55 ] Doxygen 1.4.7 age 356 名前：デフォルトの名無しさん mailto:sage [2006/06/14(水) 14:33:53 ] ちょっと見やすくなったね＞1.4.7 357 名前：デフォルトの名無しさん [2006/06/22(木) 09:09:28 ] 1.4.7 で dot を使おうとすると FreeSans.ttf が見つからんエラーになるなorz まあ、すでに bugzilla に報告済みだから次のバージョンでは何らかの対策がされることを 期待するが。 358 名前：デフォルトの名無しさん [2006/06/22(木) 10:13:30 ] 【佐賀】サムスンSDS開発のシステム不具合で市が課税ミス　昨年度はSEがデータだけ修正して誤魔化した？ news19.2ch.net/test/read.cgi/newsplus/1150936122/l50 佐賀市は１９日、市税や住民票などを管理する市独自の基幹システムでプログラムエラーが あり、国民健康保険税に課税ミスがあったと発表した。 この基幹システムは、旧市が韓国ＩＴ大手の「サムスンＳＤＳ」と約８億７千万円で共同開発し、 ０５年４月から運用を始めた。開始直後は約５０人の同社員がエラーをチェックしていた。 市情報政策課は「昨年度もエラーはあったはずだが、データを手直ししただけで、プログラム 自体を修正しなかった可能性が高い」と話している。 359 名前：デフォルトの名無しさん mailto:sage [2006/06/29(木) 23:09:03 ] www.atmarkit.co.jp/fwin2k/itpropower/admin-kun/031/adminkun031.html 360 名前：デフォルトの名無しさん mailto:sage [2006/07/16(日) 19:06:32 ] doxygenで /// @file test.hpp /// @brief doxygenテスト /// 加算 int add(int a, int b); /// 加算 加算double add(double a, double b); をドキュメント化すると最初のint add(int a, int b)しか載りません。 クラスのメンバ関数はオーバーロードしたものもドキュメントに載るのに。 何か方法はないでしょうか？ 361 名前：デフォルトの名無しさん mailto:sage [2006/07/16(日) 19:15:50 ] >>360 その 加算double ってのは何だ？ 362 名前：デフォルトの名無しさん mailto:sage [2006/07/16(日) 19:23:54 ] タイプミスです。すみません。 /// @file test.hpp /// @brief doxygenテスト /// 加算 int add(int a, int b); /// 加算 double add(double a, double b); 363 名前：デフォルトの名無しさん [2006/07/24(月) 11:03:53 ] .bat, .vbs, .rb等々どんなソースにも仕込める 簡単な書式のヘルプ作成ツールみたいなのないですか？ 例えば.batなら @echo off && goto enddoc <title>mytool</title> <description>なんか役に立つツール</description> <parameters> -h: このヘルプを表示 -v: verbose </parameters> :enddoc ... メインの処理 とかやっといてフィルタかますとmytool.htmが生成されるとかそんな感じのもの 364 名前：デフォルトの名無しさん mailto:sage [2006/07/24(月) 18:39:30 ] >>363 その程度だったら、 自分でRubyかPerlあたりでフィルタ作ればいいんじゃない？ 上の例を借りると、 @echo off && goto enddoc REM @XX_BRIEF <title>mytool</title> REM @XX_BRIEF <description>なんか役に立つツール</description> REM @XX_BRIEF <parameters> REM @XX_BRIEF -h: このヘルプを表示 REM @XX_BRIEF -v: verbose REM @XX_BRIEF </parameters> :enddoc とでもしておいて、 行中に@XX_BRIEF等の特定のキーワードが含まれるかチェック → キーワードの後ろから行末までの文字列を抽出 → 必要に応じて文字列を整形し、特定のフォーマットに変換 → ファイルに出力 という感じで。 ソースコード内の変数名やメソッド名を参照するようなことはできないけどね。 365 名前：デフォルトの名無しさん mailto:sage [2006/07/26(水) 04:08:38 ] >>360, 362 1.4.7 で問題なく出力できた。 366 名前：デフォルトの名無しさん mailto:sage [2006/07/28(金) 01:57:06 ] DQNメント 367 名前：デフォルトの名無しさん [2006/10/18(水) 11:22:21 ] Doxygen 1.5.0 age 368 名前：デフォルトの名無しさん mailto:sage [2006/10/30(月) 01:23:57 ] doxygen 使ってますが、 > Generating caller graph for function foo という行で止まってしまいます。 いつも同じ関数の処理をしている時に止まるようです。 止まってしまう関数の処理を中断して先に進ませる方法はないでしょうか？ 369 名前：デフォルトの名無しさん [2006/10/30(月) 11:19:27 ] Doxygen 1.5.1 age 370 名前：デフォルトの名無しさん [2006/10/31(火) 00:35:52 ] doxygenだと改行が無視されて せっかく綺麗に作ったコメントがぐちゃぐちゃになるんだけど なにか対策ある？ 371 名前：デフォルトの名無しさん mailto:sage [2006/10/31(火) 00:43:23 ] >>370 <pre></pre> でどう？ 場合によっては何かもっと適切な対策があるかもしれないけど。 372 名前：デフォルトの名無しさん mailto:sage [2006/11/01(水) 00:55:01 ] \n書くとか。 漏れはもう改行を気にするのはやめたけど。 373 名前：デフォルトの名無しさん mailto:sage [2006/11/01(水) 13:48:26 ] >>370 doxygenの整形に任せるのが正解。 改行が必要なほど複雑な説明を長々とコメントに書いてはいけない。 補足説明とか引数別の説明とか例外のリストとかそういうのは それようのタグがあるのでそれを使ってdoxygenに整形させる。 374 名前：デフォルトの名無しさん mailto:sage [2006/11/11(土) 11:36:25 ] 楽にドキュメントを書ける(・∀・)ｲｲ！ツールすらないことがよくわかった。 おまいら今なら作れば売れるぞw 375 名前：デフォルトの名無しさん mailto:sage [2006/11/11(土) 12:00:06 ] 脳味噌にUSBケーブル接続して脳内仕様をダイレクトに出力できるデバイスが 発明されない限り、ドキュメント作成ツールのメガヒットはありえない。 376 名前：デフォルトの名無しさん mailto:sage [2006/11/11(土) 13:26:33 ] えーそんなの出来たら おっぱいとか満載になっちゃって大変そう。 雑念払う練習しないと。 377 名前：デフォルトの名無しさん mailto:sage [2007/01/08(月) 23:42:18 ] ソースがドキュメントとか逝ってる人、勘弁してよ。 ちょっと不思議な動きしてるんですけど、 ソースのバグなんだか、仕様なんだか、わからないよ！ と、１０年以上前に誰かが作ったソースをメンテさせられることになって 鬱状態の僕は思いました。５万行もあるよ。。 みんな、doxygen使ってるか！ ちゃんと、その関数が何やりたいのとかきちんと書いてな！ あとsunのJavadocみたいに、スレッドセーフかどうかとかも書いてあるとうれしいよ！ パッケージとかモジュールとか、ソースより大きい単位でも doxygenってドキュメント書けるの？ >>374 買うから作って。 あけましておめでとう。 378 名前：デフォルトの名無しさん [2007/03/10(土) 16:46:51 ] "要求定義" "要件定義" 同じものを違う呼び方してるだけ？ 379 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 17:25:20 ] >>378 レイヤーが違う 上位が要件、下位が要求 380 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 17:53:37 ] なるほど。 これらを区別していない書籍も多いと思ったのですが、 そんなことないでしょうか？ 381 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 17:55:28 ] 多いか少ないかなんて問題なのか？ 382 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 18:40:21 ] 学習者にとっては問題です。 それぞれ英語では何という語句にあたりますか？ 383 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 20:30:09 ] >>382 要件はマターとかファクター 要求はリクエスト 384 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 20:52:38 ] requirement... 385 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 21:02:38 ] >>384 requestもrequireも語源は同じですよ re(再び) ＋ quaerere(ラテン語で求める) 再び求める ⇒ 要求、お願い requireよりrequestの方が若干丁寧です 386 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 21:49:15 ] >>378 海外では"requirements definition"。 日本の計算機屋の言語感覚が鈍かったから、「要求」と「要件」がごっちゃになってる。 「要求」の方だけ覚えときな。 387 名前：デフォルトの名無しさん [2007/03/10(土) 23:01:13 ] "要求"・・大学・研究機関で使われる "要件"・・企業で使われる だろ？ 388 名前：デフォルトの名無しさん mailto:sage [2007/03/10(土) 23:27:23 ] "要件"・・営業が使う 389 名前：デフォルトの名無しさん mailto:sage [2007/03/12(月) 01:50:03 ] うーん。　難しいんですね。 レイヤーが違うというなら、 比喩的に、ボールペンの 要求定義、要件定義はどのようになるんでしょうか。 390 名前：デフォルトの名無しさん mailto:sage [2007/03/12(月) 21:24:59 ] >>389 [要求] 先端は鋼などの硬球 運筆に応じて回転、軸内のインクが滲出 391 名前：デフォルトの名無しさん mailto:sage [2007/03/12(月) 22:01:44 ] それは仕様じゃないの 392 名前：こんなもんかな mailto:sage [2007/03/13(火) 10:29:20 ] 仕様 速記に適し、それなりの耐久性を有すること。 ある程度の耐候性があればインクの種類は問わないが、掠れ難いこと。 393 名前：デフォルトの名無しさん mailto:sage [2007/03/13(火) 10:52:47 ] [要求] 字が書けること 394 名前：デフォルトの名無しさん mailto:sage [2007/03/13(火) 23:51:25 ] >>392 そっちのが要求じゃないの あっこれマジレスってやつかっ？ 395 名前：デフォルトの名無しさん mailto:sage [2007/03/14(水) 00:16:56 ] 「要件」は何？ 396 名前：デフォルトの名無しさん mailto:sage [2007/03/14(水) 00:48:48 ] 要件定義書 ver0.00 - 普通紙に字が書けること - インクの補充が容易であること - 出来うる限りメンテナンスフリーであること 以上の要求を実現する筆記用具を開発することにより、ユーザーの利便性を高め 生産性の向上に（以下省略 ＞以上の要求を実現する筆記用具を開発することにより、ユーザーの利便性を高め ＞生産性の向上に（以下省略 ↑この辺が要件。 397 名前：デフォルトの名無しさん mailto:sage [2007/03/14(水) 01:06:54 ] ttp://www.atmarkit.co.jp/farc/rensai/lookingfor04/lookingfor04a.html 少なくとも日本IBMでは区別してるようだな。 IEEEでは単にSoftware/System Requirements Speciticationであって、 区別してないようだな。 398 名前：デフォルトの名無しさん mailto:sage [2007/03/14(水) 01:19:00 ] 俺もIだけど、要求しか使わないよ。 上の例で挙げられているような仕様書は、 今どきコボラーくらいしか書かないんじゃないかな。 399 名前：デフォルトの名無しさん mailto:sage [2007/03/14(水) 04:30:05 ] 要望と要求と要件は微妙に違うという意見もある 要望は客が単に思ってること 要求はシステム上不可欠なこと 要件は実装するシステム機能 ま、いちいち分類したところで、結局ドキュメントを書かないもれには関係ない話だｗ 400 名前：デフォルトの名無しさん mailto:sage [2007/03/15(木) 00:34:54 ] 要件とは顧客の要望や要求を日本語に文章化したものではないかと思います。。。 その意味じゃ>>396の言ってる事がしっくりくるｗ 401 名前：デフォルトの名無しさん mailto:sage [2007/03/15(木) 17:05:37 ] management textでいうプロジェクトリーダーの理解＝要件 ってこと？ 402 名前：デフォルトの名無しさん [2007/03/18(日) 15:15:13 ] プログラム単体レベルで考えると、破綻する。 システム全体を見据え、ドキュメントを体系化すべし。 富士通だと、SDAS ttp://img.jp.fujitsu.com/downloads/jp/jmag/vol57-1/paper01.pdf NEC、日立も似たようなもん持ってる。（どれが良いとかはシラン） 孫会社、下請けは知らないかもしれないが、本尊の動きくらい知っときなょ。 403 名前：デフォルトの名無しさん [2007/03/18(日) 21:26:20 ] 俺の考えは、 マニュアル　→　専門のテクニカルライターを使う 設計書　　　→　システム全体が見渡せるもの／外部仕様はしっかり書く。 　　　　　　　　内部仕様はほどほど。（結局ソースが正になるから） ドキュメントが無いソフトは糞とかいうけど、 ドキュメントが無いと保守できないソフトこそ糞だと思う今日この頃だよ。 404 名前：デフォルトの名無しさん mailto:sage [2007/03/18(日) 23:12:23 ] 全体の概要とか外部仕様、内部仕様を区別せず、 一口にドキュメントの是非を問うから議論が分かれる気が。 >>403 が言うとおり、 システム全体像・外部仕様はしっかり、 内部仕様はソースが正、doxygen とかで自動生成 って言えば、あんまり反対する人いないと思うんだけど。 405 名前：デフォルトの名無しさん mailto:sage [2007/03/18(日) 23:15:45 ] マーケティング部門向けの仕様書って 開発用と別に書いて渡してますか？ 406 名前：デフォルトの名無しさん mailto:sage [2007/03/19(月) 00:49:55 ] >>404 内部仕様書でも、分業単位の分まではきっしり作っておこう 407 名前：デフォルトの名無しさん mailto:sage [2007/03/19(月) 04:40:13 ] >>403 上場企業だと、内部統制の関係で全てキッチリ必要 408 名前：デフォルトの名無しさん [2007/03/27(火) 23:59:41 ] unmanagedとmanagedのコードが混在したアセンブリのドキュメントってdoxygenで出力できますか？ CVSに入ってるdoxygenだとCPP_CLI_SUPPORTという設定が使えるみたいなんだけど 409 名前：デフォルトの名無しさん mailto:sage [2007/03/28(水) 09:19:09 ] >>407 上場企業というより、メーカー系の企業だな。 やつらは工場で作るものとソフトウェアを同じ体系にまとめようとするからムリがある。 上場企業でもソフトハウス系はそんなことない。 410 名前：デフォルトの名無しさん mailto:sage [2007/03/28(水) 12:50:41 ] >>409 でも、工場で作るものと同じ仕様で仕様書を作っておくと 何年後でも開発者が死んだあとでもメンテが出来たりするので あなどれないんだよな 411 名前：デフォルトの名無しさん mailto:sage [2007/03/28(水) 18:55:58 ] 小さな会社が手がけるレベルの開発じゃそこまでライフサイクル長くない… 412 名前：デフォルトの名無しさん mailto:sage [2007/03/29(木) 09:16:07 ] あって役にたつのは、外部仕様書と内部実装の理解を助けるための簡単なドキュメントだな。 それ以上細かい内部仕様書は糞。 思うに、本当の内部仕様書ってのはソースコード自身だと思う。 413 名前：デフォルトの名無しさん mailto:sage [2007/03/29(木) 11:35:18 ] >>412 それじゃ バグがあっても仕様通り ぢゃあないか 414 名前：デフォルトの名無しさん mailto:sage [2007/03/29(木) 11:50:55 ] そうそう、大抵納品後数年経ってから発覚するような(必ずしもバグでない)不具合があったときに 一番役立つのがソースコードとソース内にきちんと書かれたコメントなんだよね。 尤も、それらがきちんと書かれていないコードに限って後から不具合が露見するんだが。 で、ついでに言えばそういうプロジェクトは大抵仕様書に仕様変更がきちんと反映されていないから仕様書は手掛かりにしからない罠。 415 名前：デフォルトの名無しさん mailto:sage [2007/03/29(木) 12:14:21 ] 勝手に転載 979 名前： デフォルトの名無しさん [sage] 投稿日： 2007/03/29(木) 10:14:13 処理Aの仕様書 ・・・Aを実行する。 １行きたー。どうしよう。 416 名前：デフォルトの名無しさん [2007/03/29(木) 23:41:27 ] 良いDQNなんていません 417 名前：デフォルトの名無しさん [2007/04/05(木) 13:28:09 ] Doxygen 1.5.2 age UTF-8 ｷﾀ 418 名前：デフォルトの名無しさん mailto:sage [2007/04/14(土) 22:07:50 ] 要件定義書とか設計書とかのフォーマットはダウンロードできるとこありますか？ 書籍でも良いです 419 名前：デフォルトの名無しさん mailto:sage [2007/04/14(土) 22:33:19 ] RFP本とUML設計本くらいしか知らない。 実務資料はふつープロジェクト外秘や社外秘だから 必要なら会社で見せてもらえ 420 名前：デフォルトの名無しさん mailto:sage [2007/04/14(土) 22:35:59 ] ためしに 設計書 フォーマット でググったら、 見覚えあるプロジェクトの公開資料が出てきてびっくらこいたｗ 421 名前：デフォルトの名無しさん mailto:sage [2007/05/16(水) 01:23:38 ] スレ違いかもしれませんがdoxygen使いの方が 多そうでしたので質問させてください。 WinXPProSP1 VB6.0で開発を行っており、 このVBのソースをdoxygenに出力させたいのですが、 どなたか方法をご存知の方はいらっしゃらないでしょうか? ネットを漁りvbfilterを使用し、tee.exe/gawk.exe/sh.exeも必要との事でインストールし、 input-filterに 「C:\vbfiltervbfilter.bat C:vbfilter\tools」と入力し なんとか変数一覧やメソッド一覧等が出力されるようになったのですが、 コメント部分の文字が化けてしまいます。 VBのソースがshift-jisで書かれておりdoxygenのinput-encodingが UTF-8になっておりましたので、nfk.exeもインストールしdoxygenのinput-filterに 「C:\vbfiltervbfilter.bat C:vbfilter\tools|"nfk -w"」 としてみたのですがうまく変換されません。 (nfk単体で確認した所うまくshift-jis→utf-8変換処理は動作しておりました。) 恐らくdoxygenのinput-filter辺りでうまくパイプ処理が使えていないのが 原因だと思います。 ４〜５時間ほど試してみたのですが自分の力では解決できず 書き込みに至った次第です。 説明不足も多々有ると思いますがどなたか 方法をご存知の方がいらっしゃいましたらご教授のほどよろしくお願い致します。

---

---

[ 続きを読む ] / [ 携帯版 ]

read.cgi ver5.27 [feat.BBS2 +1.6] / e.0.2 (02/09/03) / eucaly.net products.
担当:undef