アカウント名:
パスワード:
コメントが丁寧に書いてあって、無駄に過去の変更点が残されたりしてないコード特に、実装中に仕様変更が入ったりして、ドキュメントからは漏れてるような、ビジネスロジック上の特異なものがコメントされてる事
＞誰が見てもわかるコードそんなものはない。
一方で「作った本人以外には読めないコード」というのも確かにあるんだけどね。
何がしたくてどんな過程でなぜこう実装したのか意図がわかるコード
要件や挙動は察しがついても「どーしてこーした」がさっぱりわからんソースがあるコメントはそっちを補足しろよと言いたくなる
難読は我慢しても正解がどうにも追えないのはキツすぎる
なぜこうしたのかって普通Redmineとかそっちに書かない？
チケット番号が書いてあるとか参照先が明示されていること。ソースコードが管理される限り、RedmineがWebで運用されている状態でないとしても情報が参照可能な状態で保存されていること。が守られているのならだいじょうぶかな。
まあ最低限の情報はコメントにも残すべきと思う。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
人生unstable -- あるハッカー
誰が見てもわかるコード (スコア:0)
コメントが丁寧に書いてあって、無駄に過去の変更点が残されたりしてないコード
特に、実装中に仕様変更が入ったりして、ドキュメントからは漏れてるような、ビジネスロジック上の特異なものがコメントされてる事
Re: (スコア:1)
＞誰が見てもわかるコード
そんなものはない。
一方で「作った本人以外には読めないコード」というのも確かにあるんだけどね。
Re: (スコア:1)
何がしたくてどんな過程でなぜこう実装したのか意図がわかるコード
要件や挙動は察しがついても
「どーしてこーした」がさっぱりわからんソースがある
コメントはそっちを補足しろよと言いたくなる
難読は我慢しても
正解がどうにも追えないのはキツすぎる
Re: (スコア:0)
なぜこうしたのかって普通Redmineとかそっちに書かない？
Re:誰が見てもわかるコード (スコア:0)
チケット番号が書いてあるとか参照先が明示されていること。
ソースコードが管理される限り、RedmineがWebで運用されている状態でないとしても情報が参照可能な状態で保存されていること。
が守られているのならだいじょうぶかな。
まあ最低限の情報はコメントにも残すべきと思う。