アカウント名:
パスワード:
開発者が書かないでいる以上は、だれかがソースから解読してドキュメントを起こすしかないんだろうなあ。読めても書けない人はそういう貢献もあるねってことで。
ソース見れば実装はわかるけど、その背景や考え方がわからなかったりすることも多いんだよね。「この機能は旧バージョンとの互換のためのもので今後廃止される予定である。そのため、今後は新しい機能を使うべきである」、とか。
人のコードを触る業務が多いのですが、「背景の考え方」ってのが一番重要だと思ったり。実装されているコードってのは、やろうとしている(いた)ことの一側面を記述しているに過ぎないと思いますです。
すごく賛同します既存のソースコードからドキュメントを起こすという作業をしたことがあります
そのまま「こういう入力があればこういう動きをする」という部分は難なく書けるのですが「なぜその動きをするのか」は推測するしかないんですね
# で,とりあえず推測でテキトーな理由をでっち上げてお茶を濁すしかないんです...
あるある。特に困るのが何を目的としてこんな実装してんだよ、っての。しかもバグなのかどうなのか正解がさっぱりわからん系な。
その手のは詳細設計にも取りこぼされる事が多いから第三者に向けたソースコメントを書け、と指導してる
そのコメントが「こう動く」ってだけの内容ではなく、「○○と考えたので、□□のパターンで実装した」とかだと非常に助かる。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
開いた括弧は必ず閉じる -- あるプログラマー
ソースから (スコア:2, 興味深い)
開発者が書かないでいる以上は、だれかがソースから解読してドキュメントを起こすしかないんだろうなあ。
読めても書けない人はそういう貢献もあるねってことで。
Re:ソースから (スコア:3, 興味深い)
ソース見れば実装はわかるけど、その背景や考え方がわからなかったりすることも多いんだよね。
「この機能は旧バージョンとの互換のためのもので今後廃止される予定である。そのため、今後は新しい機能を使うべきである」、とか。
Re:ソースから (スコア:1)
人のコードを触る業務が多いのですが、「背景の考え方」ってのが一番重要だと思ったり。
実装されているコードってのは、やろうとしている(いた)ことの一側面を記述しているに過ぎないと思いますです。
Re:ソースから (スコア:2, すばらしい洞察)
すごく賛同します
既存のソースコードからドキュメントを起こすという作業をしたことがあります
そのまま「こういう入力があればこういう動きをする」という部分は難なく書けるのですが
「なぜその動きをするのか」は推測するしかないんですね
# で,とりあえず推測でテキトーな理由をでっち上げてお茶を濁すしかないんです...
Re: (スコア:0)
あるある。特に困るのが
何を目的としてこんな実装してんだよ、っての。
しかもバグなのかどうなのか正解がさっぱりわからん系な。
その手のは詳細設計にも取りこぼされる事が多いから
第三者に向けたソースコメントを書け、と指導してる
Re:ソースから (スコア:1)
そのコメントが「こう動く」ってだけの内容ではなく、「○○と考えたので、□□のパターンで実装した」とかだと非常に助かる。