- 1 名前：デフォルトの名無しさん [03/10/05 23:34]
- おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
- 82 名前：デフォルトの名無しさん [03/10/25 02:04]
- 設計者としてのドキュメント作成技法について書かれた本で
お勧めはありますか？
- 83 名前：デフォルトの名無しさん [03/10/25 02:14]
- つーか、ドキュメントは二の次だ、うごくもんつくれよ。
- 84 名前：デフォルトの名無しさん [03/10/25 02:28]
- >> ソース＝ドキュメント
>> とか言うやつはアホだな。
・・と俺もかつては思っていた、が、ソースコードこそ唯一信頼ができる詳細設計書仕様書だと思うのだ
ＰＧはそれを理解して、可視性の高いソースコードをかかなければならない。
ここでも言われているが、関数仕様書等はdoxygen等でソースから自動抽出が最も実装との差異発生率が少なくて良い
フレームワークや外部仕様リンクの仕様もできればソースに組み込めればベストだと思うが
そのようなツールは現在この世にはない。
従って、クラス図とユースケース程度のものは、自前でドキュメントを残すべきだろう
ドキュメントを大げさにするのはコストの無駄である
ドキュメント作成にコストをかけた分だけ、また、メンテナンス時のコストが発生する。
また、次第に実装との差異が増加する率が高まるだけだ。
- 85 名前：デフォルトの名無しさん mailto:sage [03/10/25 09:35]
- ソースコードをハイパーテキスト化しよう。
- 86 名前：(゜Jし゜） mailto:sage [03/10/25 10:36]
- で、ドキュメント作成する時間を取れなかったので、
コメントに詳細仕様を記述しておいたので、後で暇人を
使ってコメントから仕様書を起草しましょう、と言ったところ、
「結局、ソースを読め！かよ。これだからPGは自分勝手な…」
「ドキュメントきちんと作って…困るんだよねぇ…云々｣
PMさん…コメントと自動生成のリファレンスだけでいいんです…。
ほんとに仕様書書く時間無いんですよ、助けてください。
- 87 名前：デフォルトの名無しさん mailto:sage [03/10/25 12:19]
- そのＰＭにケント・ベックの本でもプレゼントして差し上げましょう。
「今時不勉強なＰＭは生き残れませんよ」って。
- 88 名前：デフォルトの名無しさん mailto:sage [03/10/25 13:07]
- ケント・ベックは、要求されるなら仕様書書けっていってるぞ。
- 89 名前：デフォルトの名無しさん mailto:sage [03/10/25 13:08]
- doxygenで任意の単語にリンク張りたいんだけど、
\anchorや\refいっこいっこ付ける方法しかないですか？
- 90 名前：デフォルトの名無しさん mailto:sage [03/10/25 16:14]
- 設計書と一言で言っても分野や会社によってルールも書き方もまちまちとは思う。書く場合も書かない場合もあるだろう。
本質的には「どんな書類」が「いつ・どの期間」「誰に対して」必要なのかを明確にしておく必要があると思うのだ。
・外部仕様書
大抵の職業PG,SEはある程度規模が大きいソフトウェアを作るだろうから，少なくともマニュアルに近いもの，
一般的にはもっと詳細なものを最初に作るはずだと思う。
更に言えば，殆どの奴らは既存システムの改善（保守）をやっているので，既存の操作の変更があれば，最初に
どことどこを変更って決めたものを書いておかないとユーザ（またはマニュアル部隊）が困るはず。
ユーザに渡す前なら作った後でも良いし，正直最後に微修正が入ることもあるとは思う。
昔ユーザに「ソース読めば？」って言ったプログラマが居たが喧嘩になったよ。もうアホかと…
・詳細設計書
将来の誰かに対して残しておくってこともあるだろうけど，どこをどう直したかを書類としてのこしておかないと
ビルダー（パッケージング）する奴が困ると思うぞ。ちゃんとしたSEなら，どこを直したのか把握して全体の
調整もするはずだ。馬鹿SEも多いが，そういう書類を作って公開しておけば隣近所の奴が何やっているのかも
分かるしね。ソースから読めって奴もいるだろうけど，STABLE な状態ばっかりで開発できる羨ましい環境で
生活してんだなと思うぞ。
んじゃ。
- 91 名前：デフォルトの名無しさん mailto:sage [03/10/25 16:59]
- >>90
すんごいローカル定義だこと。
- 92 名前：(゜Jし゜） mailto:sage [03/10/26 11:50]
- ちなみにそのプロジェクト、外部仕様書は件の暇人を使って
書かせていたのでユーザには迷惑は掛かりませんでしたが…。
そしてそのPMは寄寓にもジャスト35歳だったりして。
結局、自分で書きましたよ、ええ。
後でメンテする人が困るし。
- 93 名前：デフォルトの名無しさん mailto:sage [03/10/26 12:20]
- >>92
きみが書いた仕様書は、誰も解読できないと思うけどね・・・
- 94 名前：(゜Jし゜） mailto:sage [03/10/26 23:59]
- >>93
痛いところを突きますね。
確かに自分の書いた仕様書は自分用のメモみたいな程度のもんでした。
でもまぁ無いよりはましかな、とか思ったもので…。
まーその辺の現実に目を背けたくてこんなスレにいるわけですが。
- 95 名前：デフォルトの名無しさん [03/10/27 13:04]
- 自分はＳＥではなくプログラマーなのですが
プログラマーとしてドキュメントはどんなものを書いていますか？
ウチは外注のソフトハウスで
ＰＭ・ＳＥは元請け会社がやっています。
元請け会社が作った、基本仕様書（仕様書とは名ばかりで、機能が羅列して書いてあるだけ）
を元にプログラムを書くのが
我々の仕事なのですが、
元請け会社に提出用のドキュメントや、
社内の人間に、自分が休んだり辞めたりした後に
他の人でも対応して貰えるように残しておくドキュメントとして
どんなものを作って（書いて）いますか。
ちなみに、今、私は一太郎でドキュメントをシコタマ書いていますが
ドキュメントを書く便利なツールやソフトって無いですか？
- 96 名前：デフォルトの名無しさん mailto:sage [03/10/27 13:18]
- DBから吸い出せば一発で分かるテーブルレイアウト図なんかいりません。
ER図(これもツールで吸いだせるケース多し)と、DFDだけは残してください。
全文検索に引っかかりにくく死蔵になりやすいOffice文書も正直ｲﾔです。
- 97 名前：95 [03/10/27 13:21]
- ちなみにウチの会社
ドキュメントの作成が、みんなマチマチで
ロクなドキュメントを残さないので、
「作った本人しかわかりません、触れません」状態になっており
休みの日にドラブルが起きると
家や携帯に電話が入る。
おちおち、休んでもいられない
杜撰な会社です
- 98 名前：デフォルトの名無しさん mailto:sage [03/10/28 03:47]
- そういや、いくらがんばってドキュメント書いても、誰も読まずに聞いてくる。
- 99 名前：デフォルトの名無しさん mailto:sage [03/10/28 09:49]
- >>98
それはロクなドキュメントじゃないから。
- 100 名前：デフォルトの名無しさん mailto:sage [03/10/28 09:51]
- >>96
テーブルレイアウト図（って何だ？）を見たいと思った人間が、いちいちDBから吸いださずに
すむという理由で、テーブルレイアウト図（って何だ？）は存在しておいたほうがよい。
- 101 名前：デフォルトの名無しさん mailto:sage [03/10/28 09:52]
- >>96
Office文書がいやなら当然PDFもいやなんだろうが、だとするといったい何で書けと？
- 102 名前：デフォルトの名無しさん mailto:sage [03/10/28 10:49]
- >100
DBのテーブル毎にカラム名やキー、制約なんかを記述したドキュメントの事だけど。
テーブルレイアウトって言わない？これってローカル語なのか…ｽﾏｿ一般的には何て言うの?
DBからの吸出しは事実上ワンクリックで済む以上、手間では無いと思っているのだが・・・
>96
プレーンテキスト。あとはWikiかな。
もちろん、テキストだけで表現できない要素ならそれにはこだわりません。
OfficeやPDFだとどうしても見栄え的な部分へ力を割かなきゃいかんし更新の際に差分を
残しにくいのものも嫌いな理由の一つ。
あくまでも、内部用ドキュメントの話ね。外部に出すならワープロで作るのは構わないと思う。
- 103 名前：デフォルトの名無しさん mailto:sage [03/10/28 11:31]
- どうせおまいら"理科系の作文技術"すら読んでないんだろ？
- 104 名前：デフォルトの名無しさん mailto:sage [03/10/28 18:17]
- >>99
読んでないのにろくなドキュメントかどうか分かるわけないだろう
- 105 名前：デフォルトの名無しさん mailto:sage [03/10/28 18:50]
- 読まれないということはロクなドキュメントじゃないからだって事でわ?
- 106 名前：デフォルトの名無しさん mailto:sage [03/10/28 19:34]
- >>105
>>104
- 107 名前：デフォルトの名無しさん mailto:sage [03/10/28 21:41]
- まーふぃーの法則。
誰も読まないからドキュメントを書かないでいると、必ずドキュメントを要求される。
- 108 名前：デフォルトの名無しさん mailto:sage [03/10/28 21:49]
- 補足：
書くと今度は誰も読まない。
- 109 名前：デフォルトの名無しさん mailto:sage [03/10/28 22:16]
- >>102
> >100
> DBのテーブル毎にカラム名やキー、制約なんかを記述したドキュメントの事だけど。
> テーブルレイアウトって言わない？これってローカル語なのか…ｽﾏｿ一般的には何て言うの?
> DBからの吸出しは事実上ワンクリックで済む以上、手間では無いと思っているのだが・・・
ファイルとして保存しておけば、1秒もかからずに誰でも見始めることができるのだが。
> >96
> プレーンテキスト。あとはWikiかな。
> もちろん、テキストだけで表現できない要素ならそれにはこだわりません。
> OfficeやPDFだとどうしても見栄え的な部分へ力を割かなきゃいかんし更新の際に差分を
> 残しにくいのものも嫌いな理由の一つ。
> あくまでも、内部用ドキュメントの話ね。外部に出すならワープロで作るのは構わないと思う。
たぶんOfficeの使い方を間違っている。というか使いこなしていない。
Wikiで書いた文章を配布するときはどうするんだ？HTMLで配布するのか？
- 110 名前：デフォルトの名無しさん mailto:sage [03/10/29 09:04]
- >109
そのファイルが現物のDBを反映した物である保証があるならそれもアリですな。
>96
Officeに文書のバージョン管理の機能ってあるの?
是非教えてくれ。Officeを好きになれるかも。
配布に関しては別の話になると思うのだが・・・
まぁHTMLに吐くのもアリだしWikiによってはそのままPDF吐いてくれる物もあるし。
んで「テーブルレイアウト図」は一般的なんでしょうか。
気になって夜も眠れません・・・
- 111 名前：デフォルトの名無しさん mailto:sage [03/10/29 10:43]
- >>110
ぐぐってみりゃわかるだろうが。
日本語のページからテーブルレイアウト図を検索しました。 約6件中1 - 4件目 ・検索にかかった時間0.21秒
普通は「テーブルレイアウト」という。
- 112 名前：デフォルトの名無しさん [03/10/29 21:57]
- >>110
>Officeに文書のバージョン管理の機能ってあるの?
少なくともWordにはある。
が、ファイルがどんどん肥大化するのでお薦めできない
- 113 名前：デフォルトの名無しさん [03/10/29 22:01]
- Wordでどうやんの？
- 114 名前：デフォルトの名無しさん [03/10/30 00:25]
- 制御系のプログラマの場合、
開発した後、どんなドキュメントを残しますか？
- 115 名前：デフォルトの名無しさん mailto:sage [03/10/30 00:28]
- >>110
カラムの名称や型や制約に関する記述はスキーマとかテーブル定義書って言うんじゃ
なかったっけ。テーブル間の関連を図示したものはＥＲＤだな。
- 116 名前：110 mailto:sage [03/10/30 08:45]
- >111
あ、そういう事か。
図を抜く訳ね。
てっきり「一般的にはみかんと呼ばれる物を俺のところではりんごと呼んでいた」
くらい違うのかと思ってた。
今後気をつける。
- 117 名前：デフォルトの名無しさん [03/10/30 10:00]
- >>114
当然相手に応じて。
言われなければ俺は
回路図とかの図面はPDFにして
テキストで書ける事は全部ソースに全部埋め込む。
- 118 名前：112 [03/10/30 22:22]
- >>113
どうやんのって、持ってるならヘルプ見れよ！！！
今回だけだぞ、
[ファイル]−[版の管理...]
- 119 名前：デフォルトの名無しさん mailto:sage [03/10/31 01:07]
- ドキュメントのメンテ工数もらえないうちらはどうすればよいでしょうか
- 120 名前：デフォルトの名無しさん mailto:sage [03/10/31 12:07]
- その分別工程に上乗せ。
- 121 名前：デフォルトの名無しさん [03/11/21 23:23]
- Doxygen Release 1.3.5 age
- 122 名前：デフォルトの名無しさん mailto:sage [03/11/22 13:45]
- DoxygenでXHTMLを吐く上手い方法はないかね？
- 123 名前：デフォルトの名無しさん mailto:sage [03/11/22 17:58]
- Doxygenの出力パーサを弄くるとか。
あれってC++だっけ？
Doxygenレベルのlexerが単体で使えれば楽になることが沢山あるんだが・・。
- 124 名前：デフォルトの名無しさん [04/02/17 16:19]
- 仕様書ってーか、目論見書つくらんといけなかったのですが、
windowsのアプリ完成後のイメージを作成するのに、
簡単にコントロールぺタぺタできるのありませんかね？
ＶＣのダイアログボックスも、ＶＢのダイアログボックスもめんどくさいとこあるし・・・。
どなたか良いのありましたら教えてください。
- 125 名前：デフォルトの名無しさん mailto:sage [04/02/18 00:59]
- 目論見書って、金融の目論見書しか知らないんだけど。
その目論見書？
それにWindows の UI を乗せる必要がある？
- 126 名前：デフォルトの名無しさん [04/02/18 09:21]
- >>125
レスありがとうございます。
なんつーんでしょうかね？まぁ、こんなん作りますがみたいなのを他社に送るもんらしいです。
まぁ、中身も当然ですがＵＩの使いかってがかなり重要っぽいので・・・。
もう、フリーハンドでもいいとおもうんですけどね・・・。
とりあえず、今回はまぁそれなりに書いたんでどね。
次回以降ワードあたりでしこしこ線引くのも疲れるんで、なんか楽なの無いかな？と思いまして・・・。
- 127 名前：デフォルトの名無しさん mailto:sage [04/02/18 20:18]
- Visioなら書けるが、VC・VBの方が楽。よってVisioでは無理。
- 128 名前：デフォルトの名無しさん [04/02/18 21:45]
- >>127
wxWindowsのGUIツールキットBOAとかFOXとかFLTKあたりで作成できないもんかと思って、
とりあえず、暇できたらなんか色々チャレンジしてみます。
でも、.NET対応流行ったらどうすっぺ・・・。
- 129 名前：デフォルトの名無しさん mailto:sage [04/02/18 22:36]
- FLTKは日本語まわりがアレ、wxWindowはちょっとDLLがデカイ
gtk+ 導入するのにものすごい壁がある。 Foxは知らん。
なんとなく実用的なものならwxWindowがいい、
でもどれでもポトペタは無理だと思う。
- 130 名前：デフォルトの名無しさん mailto:sage [04/02/18 22:44]
- ポトペタってなに？
- 131 名前：デフォルトの名無しさん mailto:sage [04/02/18 23:15]
- >>126
俺の会社の先輩はPowerPoint使ってデモしてました。
文字入力画面はできない(アニメーションでやってた)みたいだけど、
ボタンと画面表示はリンクで適当に作ってました。
全画面表示のアプリで、それっぽく見せてましたよ。
- 132 名前：デフォルトの名無しさん mailto:sage [04/02/18 23:42]
- まぁVBが一番楽なんだろうね。
- 133 名前：デフォルトの名無しさん mailto:sage [04/02/19 01:56]
- 画面設計書じゃないから、それこそ"○○部分"と書いた枠の配置だけでいいと思う。
というか、そうでもして抽象化しないと完成画面だと思われる。
はっきりいえば、Windows の画面かどうかも分からないように書いたほうがいい。
- 134 名前：デフォルトの名無しさん mailto:sage [04/02/19 06:20]
- もしもしTcl/Tkを忘れてますよ
- 135 名前：124 mailto:sage [04/02/19 09:35]
- >>129-134
みなさまどーもありとうございます。
>>129,132
ポトペタ（ポトッとおとしてペたって貼り付け？）は無理ですか。
ＶＢで適当につくるのがいいんですかね・・・。
でもおいらＶＢ苦手っす（なんかめんどいからかな？）。
超初心者用ページでいいページないですかね（スレ違い）。
C++ならそれなりにモウマンタイって感じなんですけど。
>>131
パワーポイントっすか。使ったことないですね。考慮してみます。
>>133
うーむ、画面設計書とかそこらへんの違いよくわからないです。
そういうのわかる書籍とかページありませんか？（スレ違い？）
とりあえず、今度は抽象化してだしてみますね。
>>134
あ、どもです。とあるページに載ってなかったもんでメジャーではないのかと思いまして。
（ここのＧＵＩスレには載ってますけど）
- 136 名前：デフォルトの名無しさん mailto:sage [04/02/26 23:15]
- 末端プログラマしかやったことないんですが、
ちょっとＰＭで設計書の類（まだはっきりしてないけど）を書く必要にせまられました。
で、役立つオススメな本あります？
- 137 名前：デフォルトの名無しさん mailto:sage [04/02/27 22:42]
- まず、身の周りに先輩達が書いた設計書(見本)がないか探してみる。
なかったり、どうしようもないような代物なら…ガンガレ。
プログラム 設計書 で ぐぐると合うような物が見つかるかもよ。
- 138 名前：デフォルトの名無しさん mailto:sage [04/02/27 22:47]
- 周りに先輩達が書いた設計書(見本)がないか探してみる。
なかったり、どうしようもない代物だったら…ガンガレ。
プログラム 設計書 でぐぐる
要求定義からやる羽目になる罠もあるのでその辺もひっかけておく。
- 139 名前：デフォルトの名無しさん mailto:sage [04/02/27 22:50]
- 二重カキコ。逝って(ry
＿|￣|○
- 140 名前：(゜Jし゜） mailto:sage [04/02/27 23:55]
- www.seshop.com/detail.asp?pid=4448
このへんどうよ？
- 141 名前：136 mailto:sage [04/02/28 05:24]
- >>137-139
ありがとうございます。あさってみます。
>>140
ありがとうございます。アキバのラオックスで立ち読みして、よさそうならかってきます。
- 142 名前：http://bulkfeeds.net/app/search2?q=UML [04/03/31 00:03]
- UML・仕様書・設計書関連2chスレッドのまとめ （siyousyo - wikich）
pwiki.chbox.com/pukiwiki.php?siyousyo
bulkfeeds.net/app/search2?q=UML
- 143 名前：デフォルトの名無しさん [04/05/11 00:16]
- doxygen 1.3.7 age
- 144 名前：デフォルトの名無しさん [04/07/18 17:51]
- 詳細設計書は、プログラム処理の羅列でいいんだよね？
- 145 名前：デフォルトの名無しさん mailto:sage [04/07/20 02:43]
- >プログラム処理の羅列
ダメ、それはプログラム設計書だNe!
- 146 名前：デフォルトの名無しさん [04/07/25 19:54]
- doxygen 1.3.8 age
- 147 名前：デフォルトの名無しさん mailto:sage [04/09/11 00:13:39]
- 142さんありがとうございます。助かりました。
激遅レスだけど、感謝です。
- 148 名前：あげ [04/09/25 05:02:40]
- doxygenで複数の言語向けのドキュメントを書くにはどうすればよいのだろう？
- 149 名前：デフォルトの名無しさん [04/09/25 05:06:02]
- www.npb.or.jp/
- 150 名前：148 mailto:sage [04/09/25 05:09:09]
- すまん。
doxygen+"two languages"でぐぐったらマニュアルの\ifディレクティブの項に書いてある事が分かった。
- 151 名前：デフォルトの名無しさん mailto:sage [04/09/28 16:09:35]
- 保守
- 152 名前：デフォルトの名無しさん [04/10/06 23:25:55]
- 運用マニュアルや仕様書だの、どこか公的な書き方の決まりはあるんでしょうか。
例えばメニュー名などはどういう括弧でくくるのか、単語末の長音はない
方がいいとか、会社とかによってルールとかはあるとは思うんですが…。
でもまちまちだとどこか新しい営業先に提案書持っていくときだの、いろんな
会社のマニュアルを保管する側とかとまどったりするんじゃないかと
思うのですが、みなさんは普通に自分の周辺ルールで書いてますか？
- 153 名前：デフォルトの名無しさん [04/10/07 01:12:28]
- doxygen 1.3.9 age
- 154 名前：デフォルトの名無しさん mailto:sage [04/10/07 01:18:23]
- >>152
今までマニュアルや仕様書を（良い悪いに関わらず）読んできた経験に基づいて決める。
どこでも見かけるルールには従う。
あ、このルールいいな、と思ったものは取り入れてみる。
このルールだめじゃん、と思ったものは自分ではそうならないように気をつける。
ま、毒にも薬にもならん意見だな。
「ドキュメント」「標準」とかをキーに検索すれば？
- 155 名前：デフォルトの名無しさん [04/10/07 23:01:14]
- 俺も結局わからないまま、ウケよかったからいいか…とか
先例でいい奴とかまねしてるが、業界として共通の表現とかって
どっかないんかな…
- 156 名前：デフォルトの名無しさん mailto:sage [04/10/07 23:10:44]
- この調子ではどうせ読む奴もわからないからいいんじゃない
- 157 名前：デフォルトの名無しさん mailto:sage [04/10/08 06:09:48]
- どうせ誰も読まないから適当でいいんじゃない
- 158 名前：デフォルトの名無しさん [04/10/13 00:00:55]
- doxygne 1.3.9.1 age
- 159 名前：デフォルトの名無しさん mailto:sage [04/10/13 01:09:00]
- doxygenやJavaDocは多言語対応まで視野に含めると、どうかなと思ったり。
- 160 名前：デフォルトの名無しさん mailto:sage [04/10/13 01:58:22]
- >>159 詳しく
- 161 名前：デフォルトの名無しさん mailto:sage [04/10/13 07:55:33]
- >>159
INPUT_FILTER使えば？
- 162 名前：デフォルトの名無しさん mailto:sage [04/10/13 17:55:43]
- 俺ぐらいのレベルだと
ソースがドキュメント
- 163 名前：デフォルトの名無しさん mailto:sage [04/10/13 17:56:44]
- ドキュメントが嘘ついている場合もあるのだ。
- 164 名前：デフォルトの名無しさん mailto:sage [04/10/13 21:45:34]
- >>162のソースは嘘をついている
- 165 名前：デフォルトの名無しさん mailto:sage [04/10/13 21:49:15]
- ソースがドキュメントと言っている奴のソースは大抵糞。
俺のソースはきれいだと腐ったソースで自分に酔ってる厨と同じ。
- 166 名前：デフォルトの名無しさん mailto:sage [04/10/13 22:08:47]
- 腐ったソースで走り出す♪
（プロジェクトが）
- 167 名前：デフォルトの名無しさん mailto:sage [04/10/13 22:33:25]
- warota
- 168 名前：Ruby!!!!!!!!!!!!!! mailto:sage [04/10/13 22:35:09]
- まつもとゆきひろ尊師は「ソースがドキュメント。バグもそこに記述されている」と仰いました。
おまえらひれ伏せ。
- 169 名前：デフォルトの名無しさん mailto:sage [04/10/14 00:53:52]
- #if 0
ドキュメントはソースだけで十分です。
#endif
- 170 名前：デフォルトの名無しさん mailto:sage [04/10/14 11:46:15]
- ×ドキュメントはソースだけで十分です。
○ドキュメントはソースだけしかありません。
- 171 名前：162==163 mailto:sage [04/10/15 12:47:21]
- >>164-166
いや、
おれが、ドキュメント書かないわけじゃないよ。
一応気を使ってdoxygen対応で書いてるぜ。
で、
わかりにくいドキュメント見るぐらいなら、ソース見るって感じ。
ドキュメント読んで信じて、騙されるぐらいなら
ソースを読んだ方が正確。時間もさほど変わらない。←これが俺ぐらいのレベル
ソースが汚い奴のドキュメントは、
やっぱりわかりにくい罠ってのもある。
一応、EffectiveC++レベル以上のその系統の書籍を数冊読んでるし、
汚いソース何個も見てきたので
ある程度の読みやすいソース書く自信あるぜ。
そういう本読んでない初心者ちゃんにはきついかも。
- 172 名前：デフォルトの名無しさん mailto:sage [04/10/15 15:14:32]
- ソースだけだと仕様なのか脆弱性なのかバグなのか区別がつかん。
ソース自体が読みやすいとか読みにくいとは全く別問題だし。
自分のソースにはバグは一切無いとか、
仕様のためのコードなのか、高速化のためのコードなのか、単にダメっぽいコードなのか、
みたいのを誰が見ても一目瞭然で区別できるとかいうなら話は別だが。
- 173 名前：デフォルトの名無しさん [04/10/17 07:34:17]
- サルベージ
- 174 名前：デフォルトの名無しさん mailto:sage [04/10/31 22:59:23]
- ドキュメントがメンテされてなくて役に立たん、というのはよくある話だ。
- 175 名前：デフォルトの名無しさん mailto:sage [04/10/31 23:06:43]
- ドキュメント更新まで含めてコーディングすればいい
- 176 名前：デフォルトの名無しさん mailto:sage [04/11/03 15:51:12]
- ドキュメントは古参ＳＥの頭の中だけってプロジェクトもあるよねえ（溜息）
- 177 名前：デフォルトの名無しさん [04/11/23 20:57:53]
- 今日Doxygen使い始めた。教科書はCマガジンの2002/8とDoxygenヘルプ。
*.hにコメント書くよりも*.cppに書いたほうが良い、というのは理解した。
(そりゃそーだわな)
でも、DLLなどのバイナリライブラリでソース見せたくないときは、
*.hに書くしかないような気がする。
*.cppに書いてあったコメントが、あたかも*.hに書いてあったように
Doxygenできる方法ってあるの？
それともローテクにリリース寸前でコメントを*.hにコピペするんか？
- 178 名前：デフォルトの名無しさん mailto:sage [04/11/23 21:01:35]
- おれ177
まだまだ使い始めだからわかってないのかもしれないが、
要は、ソースが丸見えになるのがいやなのだ。
ソースを隠すオプションが探し切れていないだけなのかもしれん。
- 179 名前：デフォルトの名無しさん mailto:sage [04/11/23 23:23:10]
- >>177
Doxygenした結果はcppに書いてあろうがhに書いてあろうが同じだと思うが。
ソース隠すオプションはある。
- 180 名前：デフォルトの名無しさん mailto:sage [04/11/24 15:01:58]
- というかデフォルトで隠されてたような。
WindowsならDoxyWizard使うと楽チン。
- 181 名前：デフォルトの名無しさん mailto:sage [04/11/24 19:01:47]
- おれ177
すまんかった、いろいろ試してみたらソース隠せたよ。
DoxyWizardは知らんかった、ちょっとさわってみる。
- 182 名前：デフォルトの名無しさん [05/01/03 15:58:41]
- doxygne 1.4.0 age
|
 |
