アカウント名:
パスワード:
全体を再整備するに足しになるものなら、それはそれかな...
# 最初からdoxygen前提でコメント入れたいけどね
なんだかんだ言って、第3者が見る場合に手助けとなる文書は必要だと思っています。 数日前の自分は別人ですし、自分が追うのにも役に立ちます。
先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
# doxygenのコメントを自動生成するツールが欲しい…。DoxygenToolkit.vimを使ってメソッドの先頭で":Dox"と打つの('A`)マンドクセ
>なんだかんだ言って、第3者が見る場合に手助けとなる文書は必要だと思っています。>数日前の自分は別人ですし、自分が追うのにも役に立ちます。これについてはとてもとても同意します。
でも、今回話題のツールは、
// 変数xに3を加える。x += 3;
ってなコメントのような文書を作成する残念ツールなんだと理解してます。ほんとは、/ * 現在のシステムでは、ここで追加で3回リトライする可能性を考慮する必要がある。 リトライ回数の決定要因となるのはネットワークの速度であったため、 ネットワークトポロジを変更する場合は留意すること。 また、リトライ回数を増やした場合、UIの反応速度に影響する場合があるため、増やすのは実測の上必要最小限度とし、 かつ、修正影響範囲にUI操作を含め、QAに確認すること。*/とかの文書がほしいんですよね。そんな情報、どうひっくり返したって実行コードからは読み取れないのに。。。
# そんな重要な情報、コードに埋めんなよ、というツッコミもあるんですが、# 現場デバッグしないとわかんないこともあるし、ドキュメントもすでに納品したことになってるし・・・
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
目玉の数さえ十分あれば、どんなバグも深刻ではない -- Eric Raymond
完璧でなくても (スコア:1)
全体を再整備するに足しになるものなら、それはそれかな...
# 最初からdoxygen前提でコメント入れたいけどね
M-FalconSky (暑いか寒い)
Re: (スコア:2)
なんだかんだ言って、第3者が見る場合に手助けとなる文書は必要だと思っています。
数日前の自分は別人ですし、自分が追うのにも役に立ちます。
先日、自分が書いたソースを元にその手の文章をExcel方眼紙に簡単なフローチャートと説明を起こしたのですが、思い違いとか整理できて意外と有意義でした。
# doxygenのコメントを自動生成するツールが欲しい…。DoxygenToolkit.vimを使ってメソッドの先頭で":Dox"と打つの('A`)マンドクセ
Re:完璧でなくても (スコア:0)
>なんだかんだ言って、第3者が見る場合に手助けとなる文書は必要だと思っています。
>数日前の自分は別人ですし、自分が追うのにも役に立ちます。
これについてはとてもとても同意します。
でも、今回話題のツールは、
// 変数xに3を加える。
x += 3;
ってなコメントのような文書を作成する残念ツールなんだと理解してます。
ほんとは、
/ *
現在のシステムでは、ここで追加で3回リトライする可能性を考慮する必要がある。
リトライ回数の決定要因となるのはネットワークの速度であったため、
ネットワークトポロジを変更する場合は留意すること。
また、リトライ回数を増やした場合、UIの反応速度に影響する場合があるため、増やすのは実測の上必要最小限度とし、
かつ、修正影響範囲にUI操作を含め、QAに確認すること。
*/
とかの文書がほしいんですよね。そんな情報、どうひっくり返したって実行コードからは読み取れないのに。。。
# そんな重要な情報、コードに埋めんなよ、というツッコミもあるんですが、
# 現場デバッグしないとわかんないこともあるし、ドキュメントもすでに納品したことになってるし・・・