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

1 名前：デフォルトの名無しさん [03/10/05 23:34] おまえら、自分で作ったプログラムについての、わかりやすく的確な ドキュメントを書ける自信はあるか？ 仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、 マニュアルや、仕様書などのドキュメントを書く機会は必ずある。 プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。 ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。 だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？ いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、 実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い) 読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。 プログラムに対するドキュメントを、ちゃんとした１作品として、 後世に残せるよう努力すべきだろう。 今一度問う。 おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？ 266 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 17:20:24 ] >>263-265 どれも俺からすると些末な機能なんだけど。 XSLTが大好きな俺的にはXML形式に対応してるところなんかが蝶最高なんだけど、 これはExcelやパワポでもできることだしな。 267 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 17:33:54 ] Wordの最大のウリは 多数派であるということ 268 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 17:50:31 ] >>264 最近のはマシなんか？ Wordでページ数多い文書作ると重いわすぐ落ちるわで…… いい印象無かったんだが 269 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 18:28:11 ] >>264-265 この辺のテンプレート集とかスクリプト集ってある？ 折角の利点も簡便で分かり易くないと説得が難しい。 偉いさんてのはプライドを刺激されると意固地になるからな。彼らは難しいとか 理解できないを決して口にせず、それらを必要がないの一言で片付けてしまう。 270 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 18:32:51 ] >>267 Excelの方が多数派だよ？ 総務などの非生産部門には必ずと言っていいほどExcelが導入されてるから 271 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 18:33:14 ] >>269 目次だのなんだのって、単なるWordの基本機能だから、スクリプトは不要だよ。 ちゃんとスタイル使って（「見出し1」とか「見出し2」とか）文書を 書けば、章番号を自動で振ってくれるし、後でそれをもとに自動で目次が作れる。 272 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 18:34:18 ] >>270 ExcelとWordでは用途が違うというだけの話だ。 適材適所で使い分けるのが賢いやり方。 273 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 18:51:04 ] >>271 ありゃ？そうなのか、て言うか基本機能なのかよ！ 俺自身が実際に触って、基本機能くらいは理解しないと話にもならんな＿|￣|○||| それが何とも億劫と言えば億劫なんだが…… 俺も偉いさんの事をとやかくは言えんな…… >>272 問題は、決して賢くないという点だ！Σ(´Д｀ ） 274 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 19:02:01 ] >>273 www.amazon.co.jp/exec/obidos/ASIN/4774117501/ この本がおすすめ。 アウトラインモードで取り敢えず書くのが 自然に思えてきたら結構使ってる人なんじゃないでしょか。 275 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 21:47:06 ] >>273 俺、元々LaTeX派だったけど、3日でWordに転向しちゃったよ。 割とすぐ覚えれる。 276 名前：名無しさん＠そうだ選挙に行こう [2005/09/11(日) 21:50:52 ] >>274 この本、自分も人から薦められて買ったけど、かなりいい本ですね。 職場に一冊常備すべし。 277 名前：名無しさん＠そうだ選挙に行こう mailto:sage [2005/09/11(日) 22:54:18 ] Win板かソフ板の話題が続いている件について 278 名前：デフォルトの名無しさん mailto:sage [2005/09/12(月) 00:35:07 ] >>274-276 ホントかよ？ジエリじゃねぇだろうなｗ とりあえず明日本屋行ってくるよ。初心者向けではないみたいだから 一緒に入門書も買ってくる。 279 名前：デフォルトの名無しさん mailto:sage [2005/09/12(月) 00:59:59 ] >>278 じえんじゃないよ。 まあじえんだとしてもいいじゃん 本屋で立ち読みしてみて決めてちょー。 カラーページがないところとかが硬派で それだけで好感が持てますだ。 DTPのマナーみたいな話も、システム文書には 必要ないけど、面白かったな。 280 名前：デフォルトの名無しさん mailto:sage [2005/09/16(金) 00:55:41 ] Wordのスタイル機能は書式をいぢりづらいのがネック。 特にスタイル使わずに書かれた文章にスタイルを導入しようとすると死ねる。 281 名前：デフォルトの名無しさん mailto:sage [2005/09/16(金) 10:45:36 ] >>280 あとからは相当骨でしょそりゃー。 282 名前：デフォルトの名無しさん mailto:sage [2005/09/23(金) 00:26:28 ] なんかMSワードって何処でも決まって悪者にされる傾向があるけどなんでだろうね。 俺はかなり良いソフトだと思うんだけど。いやマジで。 今までアドビのフレームメーカーとかロータスのワードプロも触ってきてるけど ワードのUIはそれらより飛びぬけて直観的だし、機能も多い。 ワード使い難いって奴はフレームメーカー使ってみるといいかも。 フレームメーカーの糞UIはマジで殺したくなるよ。それでいてワードより高かったりしたから恐れ入る。 まあでも時々挙動不審だったりするし、段落番号の設定みたいに異常にわかり難い UIがあったりする欠点は確かにあるな。 それにしても、ワード貶してる奴らに関しては、ワードの問題というより そいつらの能力の問題じゃないかと思うが。 283 名前：デフォルトの名無しさん mailto:sage [2005/09/23(金) 01:07:59 ] デフォルト設定のせい UNIXが使いにくいのとおなじ 284 名前：デフォルトの名無しさん mailto:sage [2005/09/23(金) 11:01:41 ] それにしても、UNIX貶してる奴らに関しては、UNIXの問題というより そいつらの能力の問題じゃないかと思うが。 285 名前：デフォルトの名無しさん mailto:sage [2005/09/23(金) 14:04:57 ] じゃあWordに文句を言うやつも無能だな。 286 名前：デフォルトの名無しさん [2005/10/10(月) 16:31:55 ] >>285 そりゃ無能だろ 287 名前：デフォルトの名無しさん mailto:sage [2005/10/10(月) 17:27:01 ] あーでもWordの使いにくさとUNIXの使いにくさは別だな。 UNIXはどうしようもないからな。 288 名前：デフォルトの名無しさん [2005/10/10(月) 17:33:25 ] doxygen 1.4.5 age 289 名前：デフォルトの名無しさん mailto:sage [2005/10/10(月) 17:34:07 ] なんで並列に語ってるのか知らないけど あえてノルなら Wordの使いにくさは 袋小路 であり、UNIXの使いにくさは 迷路 だ。 Wordでやりたいことをやるとき、正式な方法が無いことはよくあり 正式じゃない方法で突破することが多い UNIXでやりたいことをやるとき、正式な方法がそもそも難解で そのことを訴えると「道があるんだからいいだろ」と突っぱねる 290 名前：デフォルトの名無しさん mailto:sage [2005/10/10(月) 18:29:51 ] Linuxの場合、とっつきやすさや使いやすさを最初から目指していないのだから使いにくくて当然な気がする。 Wordはなー。MSってUIにけっこう力入れてるはずなのになんであんなことになるのか。 291 名前：デフォルトの名無しさん mailto:sage [2005/10/10(月) 19:38:35 ] 英文だと一般の評判多少マシなのか？ 292 名前：デフォルトの名無しさん [2005/10/11(火) 11:07:21 ] ドキュメンテーションを書くときは常に例を書き込むとかなりグー。 PHPのドキュメンテーションなんていい例じゃないかな。 使い方系のドキュメンテーションはシナリオ書いとく。 ところで、結局Wiki立てても書くのは結局一人だけだよなぁ。 でもみんなで書くという機能よりも手軽にどこからでも書けるというのが気に入ってる。 使いこなすとかなり快適。あとはVISIOでちょっと図を描いて終了。 293 名前：デフォルトの名無しさん mailto:sage [2005/10/27(木) 03:40:16 ] 確かにリファレンスとかは、 動作例ある方が読みやすいもんな。 つーか動作例無いと、リファレンスに見えないというか。 294 名前：デフォルトの名無しさん mailto:sage [2005/11/01(火) 01:47:40 ] ドキュメントなんか書いてる暇があったらソースを書け。 295 名前：デフォルトの名無しさん [2005/11/06(日) 15:48:48 ] 概要仕様はワープロソフトできっちり作るな。納品しやすいし。 細かい仕様はソースにコメント埋めまくり。 ワードとかUNIX使いこなせない香具師はスキル低いだけ。 何か一つだけしか覚えられない香具師がエクセル使っている感が有るな。 自由紙、原稿用紙、レポート用紙、方眼用紙っていろいろあるけど、どれか一つ選べって状態で方眼紙選んじゃってるだけだ。 レポート用紙にグラフも書けるのにさ。 296 名前：デフォルトの名無しさん [2005/11/11(金) 16:36:53 ] どのソフトを使うかなんか関係ないって。中身ですよ中身。 つーか、こんだけソフト開発が行われてるんだから、もちっとドキュメント作成技術も洗練されていてくると思うんだけどな〜。 どこのプロジェクト行っても、読まれない＆読んでも意味ないドキュメントばっか。 新規で起こす時も役にたたねぇだろうなーと思いつつ作ってるし。 それともオレが知らないだけで、既に良いツールor作成理論とかあったりするの？ もしあったら教えてエロイひと 297 名前：デフォルトの名無しさん mailto:sage [2005/11/11(金) 22:53:22 ] >>296 コツを教えてあげるよ 自分が欲しいと思えるドキュメントを作ればいいよ 役に立つように作るべし 役に立たないと思った個所はどんどん削除 298 名前：デフォルトの名無しさん mailto:sage [2005/11/11(金) 22:55:25 ] あと、起承転結では読みづらいので 起結承転 を心がけること 299 名前：デフォルトの名無しさん mailto:sage [2005/11/11(金) 23:11:01 ] 正直「転」はいらん。 300 名前：デフォルトの名無しさん mailto:sage [2005/11/11(金) 23:23:41 ] 統合設計書作成アプリケーション作って。 普通のアプリでWikiっぽい機能＋Wordの章番管理＋Excelみたいな表が 自由に作れる幹事で 301 名前：デフォルトの名無しさん mailto:sage [2005/11/12(土) 08:19:16 ] 転ってアレか。 この関数は○○の機能を持つ <- 起結 ただし、××の副作用を持つ <- 承転 302 名前：デフォルトの名無しさん mailto:sage [2005/11/12(土) 17:11:51 ] さすがにtxtを推奨する奴はいないようだ。 303 名前：296 mailto:sage [2005/11/14(月) 09:43:53 ] いや、ドキュメント書けないわけじゃないないけどね。 この業界、結局ウォーターフォール型がほとんどじゃない？ だったら　要求＞仕様＞設計＞試験　ぐらいのテンプレートとか支援ツールあってもいいんじゃねーかなと思って。 それに有名な規格ができたら、顧客の理解度、満足度ももっと高くならないかなぁ。とか （Rational Rose とかは勘弁な。”UML図”だけじゃレビュー通らないし） あと変に思うのは設計書。実装イメージをそのまま文書にしたのをよく見かけるけど、設計書は利用者ガイドであるべきだと思うんだ。 あの高いソフト買うと付いてくる大量のマニュアル郡みたいに、コンセプト、概要、実装サンプル、注意点、とか。 設計者が変わりに文書で実装しても意味ないっしょ。 あ〜ぐだぐだと駄文書いてスマヌ 304 名前：デフォルトの名無しさん mailto:sage [2005/11/14(月) 10:41:15 ] 俺もそう思う。 納品物としての仕様書なんかいらん。読んでくれないし。 きっちり書いたユーザーマニュアル納品すれば一番ブレがない。 要求は全てそこに落とせばいいんじゃないかなあと。 だからマニュアルといっても画面の説明だけじゃなくて 半分業務マニュアルって感じ。 所謂仕様書らしい仕様書は、 お客さんにガッチガチの情シスがあって そこが出せっていうんだったら書くよ、って感じで いいんじゃないでしょうか。 なんか仕様書とあまり変わらないか。 でも言葉とかフォーマットとか、もっとお客さんに優しい感じ。 305 名前：デフォルトの名無しさん mailto:sage [2005/11/14(月) 13:50:36 ] 納品物としての仕様書は、 質重視ではなく量重視だな。 306 名前：デフォルトの名無しさん mailto:sage [2005/11/14(月) 15:40:39 ] すると普通の仕様書より表現が冗長になりそうな マニュアルでの納品がやっぱいいな スクリーンショットわんさかで 307 名前：デフォルトの名無しさん mailto:sage [2005/11/14(月) 21:10:06 ] >>301 そんな感じ 注意事項 308 名前：デフォルトの名無しさん mailto:sage [2005/11/15(火) 01:24:59 ] >>306 マニュアル + クラス仕様書(自動生成したもの) が最強。 そして両面印刷なんてもってのほか。 309 名前：デフォルトの名無しさん mailto:sage [2005/11/29(火) 03:00:58 ] >>254 亀レスすまそ。 よくExcelのセルを方眼紙みたい（正方形）にする人がいるんだけど、 あれって何が便利であんなセルにしちゃうわけ？ レイアウトしやすいってだけ？ 310 名前：デフォルトの名無しさん mailto:sage [2005/11/29(火) 10:04:30 ] 本当に方眼紙に仕様書を書いてた名残らしい。 あと、インデントしやすいからといってた。 311 名前：309 mailto:sage [2005/11/30(水) 18:12:53 ] >>310 方眼紙ってそのまんまかいなｗ 312 名前：デフォルトの名無しさん [2005/12/31(土) 19:33:11 ] doxygen 1.4.6 age 313 名前：デフォルトの名無しさん mailto:sage [2005/12/31(土) 20:00:13 ] wiki風の装飾付きtxtを書いて、自前ツール通してhtmlにしてるな。 リンクやレイアウトが簡単だし、ブラウザは誰でも入ってるから。 314 名前：デフォルトの名無しさん mailto:sage [2006/01/25(水) 17:59:27 ] doxygenのマニュアル読んでも、「使わねー」とか「ソース汚なくなるだけー」 みたいなコマンド(キーワードや記法)が多いと思ったんだけど、どう？ おまいらのdoxygenボキャブラリーはどんなもんよ？ 315 名前：デフォルトの名無しさん mailto:sage [2006/01/25(水) 22:45:51 ] file brief author pre post param return retval 後メンバグループにname { } 316 名前：デフォルトの名無しさん mailto:sage [2006/01/27(金) 09:26:58 ] >>315 それだけあれば、ひととおりの仕様は説明できそうだよね。 「意見」なんかを入れはじめるとややこしくなるんだよね。 317 名前：デフォルトの名無しさん [2006/02/25(土) 02:38:32 ] ドキュメントが書けないやつは自分の頭でわかってないからだ。 自分ではわかってるけど説明するのが下手というやつは、自分でも わかってない。それは直感と連想能力とヒントでピントでプログラミング してるだけだ。 318 名前：デフォルトの名無しさん [2006/02/25(土) 11:59:02 ] 16分割の最初の2枚ぐらいでわかっちゃうようなやつには ドキュメント作成なんてまだるっこしくってやってられんのだろうな。 馬鹿の気持ちが分からないから、標準からはずれたのを作成してしまう。 医者なんかでもそうだけど、臨床とかエンドユーザーが絡む作業は あんまり頭が切れるヤツは向いてなくて、 ちょっと馬鹿だけどそれを自覚して慎重・着実に作業する ヤツの方が向いてる。 319 名前：デフォルトの名無しさん mailto:sage [2006/03/04(土) 02:25:09 ] ソフトウェア開発の世界標準フォーマットみたいなもの無いかな 各工程で何の文書が必要で、どのような項目を記載するものだ、みたいな 320 名前：デフォルトの名無しさん [2006/03/32(土) 17:58:17 ] UMLって客に見せても実際は理解してもらえない。 客側に上級シスアドみたいなのがいれば話は別だが、現在ではそんな状況はあまりない。 結局UMLで書くってのは設計者のオナニーなんだなと思う。 なにしろUML試験なんかあるくらいだから、コンピュータど素人のお客にわかりやすいわけがない。 ところでXP開発におけるドキュメントの生成の仕方ってどうしてる？ うちは要件定義書が文章じゃなくて業務フローのの図だけなんだが。 そんなのが入力では詳細設計書なんて書けないぜ。 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メント

---

---

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

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