アカウント名:
パスワード:
開発者が書かないでいる以上は、だれかがソースから解読してドキュメントを起こすしかないんだろうなあ。読めても書けない人はそういう貢献もあるねってことで。
そろそろどっかの天才が「ソースを食わせるとドキュメントを吐き出してくれるソフトウェア」というのを発明してくれないものか。
ドキュメントと一言で扱われることが多いけど、階層や想定読者で違うよね。
このコメント [srad.jp]で言われているような、ポリシーや方針みたいな大雑把なものから、動作オプションの影響範囲と差、さらに細かくは関数の引数の意味、みたいなものまで。
ドキュメントを出せ、は「俺が知りたいことが 1ページで書いてある資料をだせ」なことも多くて、結局 google だったりする。 (私はお前のおかあさんじゃない)
C++にソースからクラス相関図を自動生成してくれるDoxygenというのがあるけど手でUMLを書くことを考えたらものすごい進歩だと思う#ってそういう話じゃないか
あれみても結局「スタートはどこ?」と放り出される感が半端ない。
http://www.cryptopp.com/docs/ref/ [cryptopp.com]
いや、あるだけいいんだけど。。結局はテストコードとか、実装を追うことに。
こういうアプローチは他コメント [srad.jp]のtex のシステム [wikipedia.org]の話もあるけど、別ドキュメントを生成するんばかりでなくて、そのまま printf() で出力すれば、printf() で出力できる形に exe に取り込んでくれれば いいんでないか?
時代が変わってメモリもHDDも安くなったんだから、--help とか --version で簡単に説明が得られるやりかたの伸張として、--source とやるとソースが出てくる、--documents でドキュメントが出てくる、なんてのもありだと思うが。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
吾輩はリファレンスである。名前はまだ無い -- perlの中の人
ソースから (スコア:2, 興味深い)
開発者が書かないでいる以上は、だれかがソースから解読してドキュメントを起こすしかないんだろうなあ。
読めても書けない人はそういう貢献もあるねってことで。
Re:ソースから (スコア:0)
そろそろどっかの天才が「ソースを食わせるとドキュメントを吐き出してくれるソフトウェア」というのを発明してくれないものか。
Re:ソースから (スコア:3, すばらしい洞察)
ドキュメントと一言で扱われることが多いけど、階層や想定読者で違うよね。
このコメント [srad.jp]で言われているような、ポリシーや方針みたいな
大雑把なものから、動作オプションの影響範囲と差、さらに細かくは
関数の引数の意味、みたいなものまで。
ドキュメントを出せ、は「俺が知りたいことが 1ページで書いてある資料をだせ」なことも
多くて、結局 google だったりする。 (私はお前のおかあさんじゃない)
Re:ソースから (スコア:2)
Re: (スコア:0)
C++にソースからクラス相関図を自動生成してくれるDoxygenというのがあるけど
手でUMLを書くことを考えたらものすごい進歩だと思う
#ってそういう話じゃないか
Re:ソースから (スコア:1)
あれみても結局「スタートはどこ?」と放り出される感が半端ない。
http://www.cryptopp.com/docs/ref/ [cryptopp.com]
いや、あるだけいいんだけど。。
結局はテストコードとか、実装を追うことに。
Re:ソースから (スコア:1)
こういうアプローチは他コメント [srad.jp]のtex のシステム [wikipedia.org]の話も
あるけど、別ドキュメントを生成するんばかりでなくて、そのまま printf() で出力すれば、
printf() で出力できる形に exe に取り込んでくれれば いいんでないか?
時代が変わってメモリもHDDも安くなったんだから、
--help とか --version で簡単に説明が得られるやりかたの伸張として、
--source とやるとソースが出てくる、--documents でドキュメントが
出てくる、なんてのもありだと思うが。