- 1 名前：デフォルトの名無しさん [03/10/05 23:34]
- おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
- 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辺りでうまくパイプ処理が使えていないのが
原因だと思います。
４～５時間ほど試してみたのですが自分の力では解決できず
書き込みに至った次第です。
説明不足も多々有ると思いますがどなたか
方法をご存知の方がいらっしゃいましたらご教授のほどよろしくお願い致します。
- 422 名前：デフォルトの名無しさん mailto:sage [2007/05/16(水) 06:57:14 ]
- >>421
ソースが shift-jis だってんなら INPUT_ENCODING=Shift_JIS だろ。
- 423 名前：デフォルトの名無しさん mailto:sage [2007/05/16(水) 10:48:18 ]
- 手元のDoxyfileにはinput-encodingなんてないのだが。
で、input_filter="iconv -f eucjp -t cp932"、use_windows_encodig=yes、output_language=japaneseで使ってるが。
#doxygenはcygwinので、バージョンは1.5.1。
- 424 名前：デフォルトの名無しさん mailto:sage [2007/05/16(水) 11:15:06 ]
- INPUT_ENCODING は 1.5.2 で追加されてる。
VB 使いが言う shif-jis は cp932 が正解だろうな。
- 425 名前：423 mailto:sage [2007/05/16(水) 11:21:47 ]
- >>424
情報THX。ちょっとリビジョン上げてくるわ。
- 426 名前：423 mailto:sage [2007/05/16(水) 11:50:37 ]
- がーん、未だcygwin版がリリースされてなかったw
#RedHatNetworkは1.3.9.1のままだし。
今回(1.5.2)の変更点はUTF-8対応のほか、C++/CLI対応だとか随分Win使い寄りのような。
件のinput_encodigやdoxyfile_encodingが追加されたと同時にuse_windows_encodingが無くなったようなので、
私のところでは進行中のプロジェクトのDoxyfileをいくつか修正する必要がありそうです。
#逆に、rtfとtexのencodingをわざわざ変えなくて済むようになるなら嬉しいけれど。
- 427 名前：デフォルトの名無しさん mailto:sage [2007/05/16(水) 23:22:19 ]
- 1.5.1 と 1.5.2 の間で互換性を失ってるのは甚だ遺憾。
- 428 名前：421 mailto:sage [2007/05/17(木) 02:03:27 ]
- 会社から書き込めないので遅くなりましたが、
>>422様の仰るとおり
INPUT_ENCODING=Shift_JIS
input-encoding=C:\vbfiltervbfilter.bat C:vbfilter\tools
にして見た所VBのソースが文字化けせず正常に出力される事が確認できました。
ありがとうございました。
と言うかこんな事に気付かない俺ってダメすぎですorz
的確な突っ込みありがとうございました。
- 429 名前：デフォルトの名無しさん mailto:sage [2007/05/17(木) 10:27:21 ]
- つーか、それでも書き間違える(写し間違える)辺りがなんとも。
- 430 名前：デフォルトの名無しさん [2007/06/21(木) 11:08:45 ]
- 今まで特にコメントのスタイルとか自分では決めず
コメントを書いてきたんだけど、やっぱりそれじゃ
後から見てばらばらで気持ち悪いので、何らかの
ドキュメント自動生成ツールに従った形で書こうと思っています。
doxygen / javadoc / phpdocumentor などのツールが
あるようですが、書式はそれぞれ異なるんですよね？
スレタイに doxygen / javadoc / phpdocumentor とかの文字列が
なかったから検索に手間取っちゃったよ・・・
- 431 名前：デフォルトの名無しさん mailto:sage [2007/06/25(月) 10:46:20 ]
- DoxygenにはJavadoc互換モードがあるからどっちかにあわせておけばいいんじゃない?
#phpのは知らない。
- 432 名前：デフォルトの名無しさん mailto:sage [2007/06/25(月) 12:22:53 ]
- >>430
その3つなら、PHPとJava使うときはそれぞれの、他はDoxygenでいいんじゃね。
- 433 名前：デフォルトの名無しさん mailto:sage [2007/06/25(月) 20:30:05 ]
- sandcastleでC++用のものも作れるんでしょうか？
- 434 名前：デフォルトの名無しさん mailto:sage [2007/07/06(金) 01:22:50 ]
- doxygen(Ver1.5.2)とHTML Help Workshopを使って、
Windowsヘルプを 作成しているのですが、索引が
どうしても文字化けしてしまいます。
INPUT_ENCODING = Shift-JIS
DOXYFILE_ENCODING =UTF-8
と設定し、ページに関しては文字化けは解消された
のですが… 何か解決策があれば教えてください
- 435 名前：デフォルトの名無しさん [2007/07/28(土) 08:38:52 ]
- doxygen 1.5.3 age
- 436 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 01:05:32 ]
- >>430
doxygen ではよくこの書き方が紹介されているが、個人的にあまりおすすめしない。
/*!
@brief メソッドの説明
@param p 引数の説明
@return 戻り値の説明
*/
・複数行コメントは一括コメントアウトの邪魔になるから
・実コードで引数が変更になると Doxygen の内容も変更しなくちゃいけなくなるから
（つまりコードと Doxygen の２重管理になる）
- 437 名前：436 mailto:sage [2007/08/12(日) 01:08:05 ]
- じゃあどうやるかというと
//! @brief メソッドの説明
//! @return 戻り値の説明
void hoge(
p //!< p の説明
)
{ ... }
- 438 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 01:46:25 ]
- Doxygenは警告吐くんだからちゃんとチェックすりゃいいやん。
>437のやり方だってコードとコメント両方メンテすんのはかわらん。多少近くなるが。
あと長い説明を入れにくくなるな。
- 439 名前：437 mailto:age [2007/08/12(日) 01:55:50 ]
- >>438
> あと長い説明を入れにくくなるな。
う゛、鋭いな。
- 440 名前：439 mailto:sage [2007/08/12(日) 01:56:36 ]
- 重ね重ねすまん、間違えて age てしまった
- 441 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 02:30:53 ]
- おれが昔立てたスレが上がってるな。
おまえら、ドキュメントなんて書きたくなきゃ書かんでいいぞ。
例えばWindowsにはヘルプがあるだろう。
けど、WindowsのGUIは洗練されてるから、あんなの読まなくても判るよな。
判らん奴もいるが、どうせそいつらはヘルプの読み方すら判らんアホだし、
付き合うだけ無駄だろう、と。こういった無茶な主張も今や世間が味方だ。
つまりウィンドウの操作なんて、もはや一般常識なのだ。凄い時代になった。
この概念を突き進めていけば、ユーザーはプログラムの画面を見れば、
何をすべきなのか判るという事だ。洗練されたGUIによって、プログラムと、
ドキュメントは融合を果たしたわけだ。
画面見て使い方が判らないプログラムはゴミと同じ。(これはGNU製に多い)
いや、むしろ今の時代は判らないとのたまう人間の方が、立場は下なのだ。
「ドキュメント見なくても判ります」
おまえら、この言葉を吐く自信はあるか？
- 442 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 02:56:38 ]
- >>441
GNU の作った GUI 製品って、何かあったっけ？
- 443 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 04:59:50 ]
- >>441
> WindowsのGUIは洗練されてるから
笑うところですか？
- 444 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 05:11:08 ]
- いちいち人に聞かないと笑うところも判らない、と。
- 445 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 13:51:49 ]
- >>437
void hoge( //! @return 戻り値の説明
ついでにここまでやろう
- 446 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 13:53:32 ]
- >>441
どこ立て読み？
- 447 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 16:57:19 ]
- ＞＞４４２
ＧＴＫ＋
- 448 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 17:46:54 ]
- >>447
それは GUI 製品とは言わんだろ。
画面見ただけで GTK+ の使い方がわかったら神だな。
- 449 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 21:34:45 ]
- Glade
Sylpheed
- 450 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 22:09:55 ]
- >>449
そいつらは GPL でライセンスされてるだけで GNU 製とは言わんのじゃないか？
もしかして >>1 や >>441 の言ってる GNU 製ってのは GPL でライセンスされてる
製品ってこと？それなら作者もバラバラなはずだから、ただの偏見だね。
- 451 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 22:44:33 ]
- >>441
見ただけで処理がわかるとか
どんだけ紙プログラマなのｗ
ユーザがそんなに凄けりゃ俺たち要らない子だよね（・ω・
- 452 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 22:49:21 ]
- GNU製ってったらGIMPは？
あれはフォトショのコピーUIな気もするが。
- 453 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 23:10:29 ]
- つってもGIMPがもとでGTKが生まれたわけだが
今更Cでオブジェクト指向ゴッコかよ
と思わないでもない
- 454 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 23:44:15 ]
- 仮にライブラリのインターフェースをC++にしたとして、
使う人間の方にしわ寄せがくる。DLLにしたくてもABIの問題もあるし。
COMやQTは難解すぎる。
C++はプログラマのフロントエンドとしてのみ使うべきだろう。
- 455 名前：デフォルトの名無しさん mailto:sage [2007/08/12(日) 23:49:25 ]
- GNUか忘れたけど、OpenGLなUNIXのライブラリで、
失敗すると勝手にexitやabortするアホなのがあった。
勝手に終わらすなや。straceなかったら死んでた。
- 456 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 01:11:07 ]
- wxD
- 457 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 12:02:32 ]
- 話を戻そう。
>>436
＞・複数行コメントは一括コメントアウトの邪魔になるから
一括コメントアウトってなに?
ソース管理の原則からは、不使用コードは#ifで囲ってしまうべきであり/* */や//は使うべきではない。
まして、基本的にリリース時には残さないべきなので、複数行コメントを忌避する理由はないと思う。
- 458 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 22:07:06 ]
- ソース「管理」の原則からは、ね。
でも実際に集中して作業してるときって /* */ 使わないか？
#if #endif より入力しやすいと思うんだが。
ついでに、古いコーディング規約が改定されずに使われる場合、
「VSS でチェックインするソースには原則として /**/ を含まないこと」
みたいな決まりが未だにまかり通る現場もあるんでは？（←ウチだけか？）
>> // は使うべきではない。
おまえんとこは１行コメントも #if なの？
- 459 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 22:11:15 ]
- >>458
/**/を使ってはならないという規則で/**/でコメントアウトするのは
ナンセンスな気がするが……
もっと言うと、/**/でコメントアウトするときに障害になるから
/**/を使うなということか
あまりにナンセンスすぎて意味がよくわからないな
- 460 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 22:24:42 ]
- >>459
こんな些細なネタで話を伸ばしたくないんだが。
/**/ は作業中のみ一時的な目的に使うべし、
チームメンバーに公開するソースからは /**/ 無くすべし、
当然使わないコードは消すべし、
一時的に残すなら #if ～ #endif を使うべし。
ということでまぁ折り合いがついてる。
それより、
>> // は使うべきではない。
> おまえんとこは１行コメントも #if なの？
についての解答が欲しい。あんまりコメント書かない習慣ってことか？
- 461 名前：459 mailto:sage [2007/08/13(月) 22:34:47 ]
- >>460
俺は上の人とは違う（はじめて書き込んだ）ので、上での話を
俺に聞かれても知らん。
俺のことを言えば、//を禁じるのも/**/を禁じるのもナンセンスにしか
思えない。
- 462 名前：デフォルトの名無しさん mailto:sage [2007/08/13(月) 22:42:06 ]
- >>461
人違いスマソ
大人しく 457 からの回答を待つよ
- 463 名前：デフォルトの名無しさん mailto:sage [2007/08/14(火) 00:37:35 ]
- 457ではないけど、コードの無効化に//を使うなって事じゃない？
//f(a, // aのコメント
//b, // bのコメント
//c) {// cのコメント
//}
/*
f(a, // aのコメント
b, // bのコメント
c) {// cのコメント
}
*/
↑つまりこんなことするなって？（こんなことするか？）
#if 0
f(a,b,c) {
}
#endif
>>458
/* */て右手だけでシフト押したりするから入力しづらくね？
手前のキー使うから爪切ってないと辛い
#if 0
#endifのが気持ち早い
- 464 名前：458 mailto:sage [2007/08/14(火) 00:58:23 ]
- >>463
が紹介したような使い方は稀だけど、無効化した理由を添えることはあるだろう。
// int i = func();
int i = func2();
// ↑×××により○○○に変更。
/* */ の入力にシフトは使わん。テンキーについてるやつを使う。
- 465 名前：デフォルトの名無しさん mailto:sage [2007/08/14(火) 02:00:54 ]
- #if で無効化しておいて理由をコメントで添えずにコミットすることを禁止すべきだろう。
- 466 名前：458 mailto:sage [2007/08/14(火) 10:24:32 ]
- ㌧ なるほど
- 467 名前：457 mailto:sage [2007/08/14(火) 11:04:13 ]
- ＞ソース管理の原則からは、不使用コードは#ifで囲ってしまうべきであり/* */や//は使うべきではない。
読み難かったかな。
不使用コードをコメントアウトする目的で、/* */や//は使うべきではないということね。
その目的で//を使うと、例えばリリース前に消したくても通常のコメントと区別がつきにくいので消し損ねかねない。
#ifならgrepでの検出も簡単だろう。
って、>465が書いているね。更には、リビジョン管理しているなら残すべき理由もないはずだが。
- 468 名前：デフォルトの名無しさん mailto:sage [2007/08/14(火) 22:41:53 ]
- a = b;
/*
c = d;
*/
e = f;
↑こうなってるときに
/*
a = b;
/*
c = d;
*/
e = f;
*/
↑あとからこんなことする馬鹿がいるからじゃね？
- 469 名前：デフォルトの名無しさん mailto:sage [2007/08/15(水) 03:51:34 ]
- >>468
誰に向けて書いたのか知らないがそれはコンパイルエラーだから論外
- 470 名前：デフォルトの名無しさん [2007/08/18(土) 03:26:18 ]
- >>468程度でも見難いと思う程度の脳味噌ですが…
- 471 名前：デフォルトの名無しさん mailto:sage [2007/08/22(水) 00:13:17 ]
- /* */ とか #if #endif でコメントアウトされてると、grepでコードを引っかけたときに、
それが使われているコードなのかコメント化されているコードなのかがgrepの結果からだけでは分からない。
てなわけでうちでは // だけ使うことになってる。
- 472 名前：デフォルトの名無しさん mailto:sage [2007/08/22(水) 11:30:55 ]
- >>471
だからこそ、リリース版のソースにコメントアウトされたコードを残してはいけないのです。
- 473 名前：デフォルトの名無しさん mailto:sage [2007/08/23(木) 01:19:20 ]
- 当社では、コードを修正する際に修正前のコードをコメントアウトしてソースに残しておくことが
規則で定められてるんだけど、もしかしてレア？
- 474 名前：デフォルトの名無しさん mailto:sage [2007/08/23(木) 01:22:00 ]
- ＳＶＮとかＣＶＳとかは？
- 475 名前：デフォルトの名無しさん mailto:sage [2007/08/23(木) 01:50:24 ]
- >>473
いや。よくある糞規則。
- 476 名前：デフォルトの名無しさん mailto:sage [2007/08/23(木) 05:59:57 ]
- 最悪だな
- 477 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 01:10:24 ]
- >>473ごく普通のことです…orzｷﾀﾈｰ
- 478 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 10:56:27 ]
- まさか、コメントアウトされた行も含めて行数で金取ってたりしないよな。
- 479 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 11:33:09 ]
- 行数で計算して金をとってる所なんてあるの？見たこと無い。COBOLとか？
- 480 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 11:46:27 ]
- >>479
Cでも未だあるらしいよ。
- 481 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 22:18:51 ]
- 目安としてステップ数はなくても、n万行のコードって今でも言うでしょ。
- 482 名前：デフォルトの名無しさん mailto:sage [2007/08/24(金) 22:45:51 ]
- 言わない
- 483 名前：デフォルトの名無しさん mailto:sage [2007/08/25(土) 14:35:46 ]
- 某上場企業のシステムのリメイクを請け負ったけど
元のがループ使わずコピペでシコシコ行数稼いでいるプログラムがあった
マジで
- 484 名前：デフォルトの名無しさん mailto:sage [2007/09/03(月) 22:19:04 ]
- >>479
F痛
- 485 名前：デフォルトの名無しさん mailto:sage [2007/09/04(火) 07:28:56 ]
- テンプレートとかgenericsは敵だな。型の分だけ、コード増やせない。
- 486 名前：デフォルトの名無しさん [2007/10/27(土) 18:26:59 ]
- Doxygen 1.5.4 age
- 487 名前：デフォルトの名無しさん [2007/10/28(日) 13:23:14 ]
- よく、日本人は罫線をやたらと使いたがるって話があって、
たしかに、excelで、罫線使いまくったドキュメントって書くのが面倒なんだけど、
かといって、日本式のそういうドキュメントしか見たことないから、罫線なしで
かっこいいドキュメントというのが想像できません。
外国で使われてるドキュメントのサンプルみたいのを見れるところってありませんかね。
- 488 名前：デフォルトの名無しさん mailto:sage [2007/10/28(日) 20:18:16 ]
- >>487
米のミドルウェアをいくつも使ったけど、そのへんのオープンソースのよりもショボい感じ。
オープンソースのをいくつも見ればいいと思うよ。
- 489 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 01:30:01 ]
- HTMLヘルプで十分て気がする
表示ソフトいらないし、ファイル1個で済むし
*NIXで見れない？
知 る か
- 490 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 02:08:39 ]
- >489
つttp://xchm.sourceforge.net/
- 491 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 12:29:28 ]
- >>487
罫線を使わないこととExcelを使わないことはイコールではないよ。
喩えて言えば、○×をやるのに周りを囲むか(囲こんな形)か、囲まないか(井こんな形)の違い。
- 492 名前：デフォルトの名無しさん mailto:sage [2007/12/08(土) 03:09:44 ]
- doxygenで更新履歴をいじった関数に書いて、
todoリストみたいにまとめたいなと思って調べたら、
\xrefitemを使えばオリジナルの\todoができることは、わかったのですが、
関連ページ追加される項目を日付ごとにまとめて並べること方法ないでしょうか?
- 493 名前：492 mailto:sage [2007/12/10(月) 02:14:40 ]
- 以下のようにしてみました。
ALIASES += "history{1}=\xrefitem histories\1 \"更新履歴(\1)\" \"更新履歴(\1)\""
日付でソートできていないし、日付ごとに別ファイルになってしまいます。orz
もっとよい方法は無いでしょうか?
- 494 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 02:14:53 ]
- ドキュメント管理が破たんしてる業務システムの保守をやってるんだが、
・機能ごとに、仕様書があったりなかったり
・管理がずさんで、どのファイルが本物の仕様書かわからなかったり
・仕様書が現状の実装と同期がとれてなさそうだったり
てな具合。
で、どうにかせにゃアカンってことで、取り急ぎコード修正・保守作業に
最低限必要なドキュメントだけ、リバースエンジニアリングして書き起こしてる
とこなんだが、作った後の維持管理って、みんなどんな感じでやってる？
- 495 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 11:15:07 ]
- ソースと同じくCVS管理
- 496 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 17:27:36 ]
- 市役所の情報システム部門に勤務している人って居る？
- 497 名前：デフォルトの名無しさん mailto:sage [2008/01/02(水) 20:27:53 ]
- 市役所のシステム部門つっても、市職員がいる「○○市情報××課」みたいな
市役所ネイティブの部署と、運用を委託されてる会社の人が常駐している実務
部隊の２通り取り方があるわけだがどっち？
- 498 名前：デフォルトの名無しさん [2008/01/09(水) 12:59:45 ]
- DOXYGENだが、1.5.2以降、内部ユニコード処理になって、入力ファイルと
出力ファイルのエンコード指定ができるようになっているのはいいんだ
けど、言語とエンコードの指定に関係なく生成されたHTMLのヘッダ部分
は、「charset=UTF-8"」なんだが、ガイシュツ？
ブラウザ側のエンコード自動識別のおかげでHTMLドキュメントはうまく
表示できるが、HTML Help CompilerでHTML Helpファイルに変換すると、
インデックス部分の日本語が化ける。
- 499 名前：デフォルトの名無しさん mailto:sage [2008/01/09(水) 16:53:47 ]
- 生成されたindex.hhcのエンコーディングをUTF-8からCP932(ShiftJIS)に変換して、
hhc.exe index.hhpでおｋ
- 500 名前：498 [2008/01/09(水) 19:45:11 ]
- >>499
それじゃあ、ツールを使って自動化する意味ないじゃん。
他にも、index.hhpでのフォント指定やら変で、特に1.5.x以降を使う
メリットが見当たらないので、結局1.4.7に戻した。1.4.7は、Japanese
選択しとくと、「charset="SHIFT_JIS"」になる。
HTML Help をコンパイルする前にフォントを変更しても、Doxygenで生成
されるソースコードのページのフォントが変なんだよね。どうもアルファ
ベット部分だけ、無条件にArialになってるっぽい。
- 501 名前：499 mailto:sage [2008/01/10(木) 02:54:40 ]
- 自分はHTMLとPDFを生成できるようにnmake用のMakefile作って自動化してるんだが。
ツール側の対応に頼るのもいいけどさ。
- 502 名前：デフォルトの名無しさん [2008/01/10(木) 06:10:22 ]
- すいません、あるWindowsアプリ(制御系)のドキュメントを
作成するよう指示がありました。
ちなみに開発環境はTurboC++。
C++の知識レベルは、入門書１冊読んだ程度。（アプリ開発経験なし）
Doxygen使ってみたのですが、Doxygen対応コメントで作成されてないので
クラス階層とか関数呼出などの図ではイメージできるのですが、
コメントがないので、やってることがさっぱりわかりません。
そういう場合は、やはり、ソース解読しながら、
Doxygen対応コメントをひたすら打ち込むことから始めるべき
なのでしょうか？
- 503 名前：デフォルトの名無しさん mailto:sage [2008/01/10(木) 07:58:38 ]
- アプリのなんだからDoxygen関係ないじゃん
|
 |
