アカウント名:
パスワード:
全体を再整備するに足しになるものなら、それはそれかな...
# 最初からdoxygen前提でコメント入れたいけどね
なんだかんだ言って、第３者が見る場合に手助けとなる文書は必要だと思っています。 数日前の自分は別人ですし、自分が追うのにも役に立ちます。
先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
# doxygenのコメントを自動生成するツールが欲しい…。DoxygenToolkit.vimを使ってメソッドの先頭で":Dox"と打つの('A`)ﾏﾝﾄﾞｸｾ
・「数日前の自分は別人」全く同意。先日、excelでちょっと複雑な計算をした。翌日、検算が必要になり、見直したら、かなり丁寧に式を分割して書いたのに、分からなくなっていた orz
・20ン年前に、「FORTRANのソースしか無い」というシミュレーションシステムから、仕様書を起こすバイトの経験あり。おそらく、当時まだ(今も？)、海外ベンダとの立場の違いで、詳細な仕様書が入手できなかったのではないかと。割と最近話題になり、当時のバイト仲間と話してたら、そんな物件がまだチラホラと動いているんでは無かろうかと、再認識した次第。同時に、当時の自分の"いい加減さ"も再認識。そんなこんなで、本題の自動生成。中の人の構成は、途上国のIT系学部の学生にバイトに出して、上がってきた中身も英語もヨレヨレの成果物を、国内の下請けに修正させて、表紙を付ける。そうすると、機械生成したように、イイカンジにワケワカな設計書が完成すると。
>先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
対応言語などからしても、そういうイメージの処理を自動化ものでしょうねフローチャートの生成ツールは大昔からありますが、たぶんそれにコードの自動解析によって得られた情報を付け加えたようなものだと思います
ところで対応言語のJCLってどのマシンのJCLなんだろう？ こういう場合やっぱりIBMのSystem360/370～以外は有り得ないから、メインフレーマーには単にJCLで話が通るのか
対応言語などからしても、そういうイメージの処理を自動化ものでしょうね
そういう処理は自分で手を動かしてやるから考えの整理になるんであって、自動化したら今度はそのドキュメントを解析するために同じ事をしなきゃいけないだけだと思う。
>なんだかんだ言って、第３者が見る場合に手助けとなる文書は必要だと思っています。>数日前の自分は別人ですし、自分が追うのにも役に立ちます。これについてはとてもとても同意します。
でも、今回話題のツールは、
// 変数xに3を加える。x += 3;
ってなコメントのような文書を作成する残念ツールなんだと理解してます。ほんとは、/ * 現在のシステムでは、ここで追加で3回リトライする可能性を考慮する必要がある。 リトライ回数の決定要因となるのはネットワークの速度であったため、 ネットワークトポロジを変更する場合は留意すること。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
海軍に入るくらいなら海賊になった方がいい -- Steven Paul Jobs
完璧でなくても (スコア:1)
全体を再整備するに足しになるものなら、それはそれかな...
# 最初からdoxygen前提でコメント入れたいけどね
M-FalconSky (暑いか寒い)
Re:完璧でなくても (スコア:2)
なんだかんだ言って、第３者が見る場合に手助けとなる文書は必要だと思っています。
数日前の自分は別人ですし、自分が追うのにも役に立ちます。
先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
# doxygenのコメントを自動生成するツールが欲しい…。DoxygenToolkit.vimを使ってメソッドの先頭で":Dox"と打つの('A`)ﾏﾝﾄﾞｸｾ
Re:完璧でなくても (スコア:4, 興味深い)
・「数日前の自分は別人」全く同意。先日、excelでちょっと複雑な計算をした。翌日、検算が必要になり、見直したら、かなり丁寧に式を分割して書いたのに、分からなくなっていた orz
・20ン年前に、「FORTRANのソースしか無い」というシミュレーションシステムから、仕様書を起こすバイトの経験あり。おそらく、当時まだ(今も？)、海外ベンダとの立場の違いで、詳細な仕様書が入手できなかったのではないかと。割と最近話題になり、当時のバイト仲間と話してたら、そんな物件がまだチラホラと動いているんでは無かろうかと、再認識した次第。同時に、当時の自分の"いい加減さ"も再認識。
そんなこんなで、本題の自動生成。中の人の構成は、途上国のIT系学部の学生にバイトに出して、上がってきた中身も英語もヨレヨレの成果物を、国内の下請けに修正させて、表紙を付ける。そうすると、機械生成したように、イイカンジにワケワカな設計書が完成すると。
Re: (スコア:0)
C#だとGhostDocっつーVisual Studioのプラグインでそれっぽいことできるよ。メソッド名とか引数名からそれっぽい英語のコメントを自動生成してくれんの。
Re: (スコア:0)
>先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
対応言語などからしても、そういうイメージの処理を自動化ものでしょうね
フローチャートの生成ツールは大昔からありますが、たぶんそれにコードの自動解析によって得られた情報を付け加えたようなものだと思います
ところで対応言語のJCLってどのマシンのJCLなんだろう？ こういう場合やっぱりIBMのSystem360/370～以外は有り得ないから、メインフレーマーには単にJCLで話が通るのか
Re:完璧でなくても (スコア:1)
そういう処理は自分で手を動かしてやるから考えの整理になるんであって、自動化したら今度はそのドキュメントを解析するために同じ事をしなきゃいけないだけだと思う。
Re: (スコア:0)
>なんだかんだ言って、第３者が見る場合に手助けとなる文書は必要だと思っています。
>数日前の自分は別人ですし、自分が追うのにも役に立ちます。
これについてはとてもとても同意します。
でも、今回話題のツールは、
// 変数xに3を加える。
x += 3;
ってなコメントのような文書を作成する残念ツールなんだと理解してます。
ほんとは、
/ *
現在のシステムでは、ここで追加で3回リトライする可能性を考慮する必要がある。
リトライ回数の決定要因となるのはネットワークの速度であったため、
ネットワークトポロジを変更する場合は留意すること。