レガシーコードに潜む奇妙なコメント 〜信じるか信じないかはあなた次第〜

開発をしているときにコメントがあると助かりますよね。
「なるほど、ここはそういう処理をしてるのか！」と、コードの中身を詳しく読まなくとも実装を進めることができます。
しかし、時としてコメントは嘘をつき、あなたを陥れます。
特に古いシステムではこれまでに蓄積され、忘れられ、熟成されたコメントが至るところに散りばめられています。

私が普段開発をしているメール共有サービス メールディーラーはリリースから20年以上が経つサービスであり、熟成されたコメントが多数存在します。
本LTでは私が実際に遭遇したレガシーコードに潜む奇妙なコメントをご紹介し、コメントを信じることが如何に危険なことであるかを知っていただきます。

コメントを信じるか信じないかはあなた次第です！

Transcript

1. © RAKUS Co., Ltd. レガシーコードに潜む奇妙なコメント  〜信じるか信じないかはあなた次第〜 #phpkansai 株式会社ラクス  ⼤阪第⼀開発部 メールディーラー開発課 ⼭村 光平 2024/02/11 1
2. 2 ⼭村 光平（やまむら こうへい） ラクスの新卒2年⽬ メールディーラー開発課 実装チーム所属 趣味は旅⾏‧テニス‧映画鑑賞
3. © RAKUS Co., Ltd. 3 コメント読んでますか？
4. © RAKUS Co., Ltd. 4 4 読める、読めるぞ！ コメントが記述されていると理解がスムーズ
5. © RAKUS Co., Ltd. 5 5 読める、読めるぞ！ コメントが記述されていると理解がスムーズ 嘘 陳腐化 奇妙
6. © RAKUS Co., Ltd. 6 6 ⽬がぁぁ〜！ ⽬がぁぁぁぁあっ！！ コメントが記述されていると理解がスムーズ 嘘 陳腐化 奇妙
7. © RAKUS Co., Ltd. 7 レガシーコードに潜む奇妙なコメント
8. 8 // 　　 　　 if(!$isHogeSetting && !$isFugaSetting){
9. 9 // 条件分岐 if(!$isHogeSetting && !$isFugaSetting){
10. 10 // 条件分岐 if(!$isHogeSetting && !$isFugaSetting){ ノーヒント
11. 11 // エラーページにリダイレクト redirectErrorPage();
12. 12 // エラーページにリダイレクト redirectErrorPage();
13. 13 // エラーページにリダイレクト redirectErrorPage(); わかっとるわ
14. 14 // 正しいチェックサム？
15. 15 // 正しいチェックサム？ もっと自信持て
16. 16 // プルダウンを生成
17. 17 // プルダウンを生成 なおプルダウンは生成されない模様
18. 18 // プルダウンを生成 なおプルダウンは生成されない模様 // テキストを生成
19. 19 //とりあえず応急処置として削除します。
20. 20 //とりあえず応急処置として削除します。 書かれたの10年前ですが...
21. 21 //とりあえず応急処置として削除します。 書かれたの10年前ですが... 大丈夫そ？
22. 22 // 予約変数名は下記の通り。つかってはいけません。 // $db, $auth, $html, $sess, $system, $reload // リクエストパラメータ // $id . . . // 予約変数名は下記の通り。つかってはいけません。 // $db, $auth, $html, $sess, $system, $reload
23. 23 // 予約変数名は下記の通り。つかってはいけません。 // $db, $auth, $html, $sess, $system, $reload // リクエストパラメータ // $id . . . // 予約変数名は下記の通り。つかってはいけません。 // $db, $auth, $html, $sess, $system, $reload 大事なことなので二回言いました
24. 24 //変なクラスですが… //パラメータを渡して作ってください。
25. 25 //変なクラスですが… //パラメータを渡して作ってください。 不穏すぎる
26. 26 //変なクラスですが… //パラメータを渡して作ってください。 不穏すぎる 何が変か教えて
27. 27 //** 条件 ******************************************
28. 28 //** 条件 ****************************************** // 変更確定でない、
29. 29 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、
30. 30 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、
31. 31 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、 // かつ、状態「変更なし」でない) 、
32. 32 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、 // かつ、状態「変更なし」でない) 、 // または、(担当者パネルが表示されている、
33. 33 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、 // かつ、状態「変更なし」でない) 、 // または、(担当者パネルが表示されている、 // かつ、担当者「変更なし」でない) )
34. 34 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、 // かつ、状態「変更なし」でない) 、 // または、(担当者パネルが表示されている、 // かつ、担当者「変更なし」でない) ) もうやめて！
35. 35 //** 条件 ****************************************** // 変更確定でない、 // かつメールが選択されている、、 // かつ( (状態パネルが表示されている、 // かつ、状態「変更なし」でない) 、 // または、(担当者パネルが表示されている、 // かつ、担当者「変更なし」でない) ) もうやめて！ 実装者のライフはゼロよ！！！
36. 36 // バグっぽい挙動だが、今はこうなっている。
37. 37 // バグっぽい挙動だが、今はこうなっている。 それバグでは？
38. 38 // 思ったとおりに並び替えをしてくれないが、なぜか
39. 39 // 思ったとおりに並び替えをしてくれないが、なぜか いやバグやて
40. 40 //なぜ文字列???????????????????? aaaaaa
41. 41 // 見た目に影響がなくてもエラーを返す場合がある //なぜ文字列???????????????????? aaaaaa
42. 42 // 見た目に影響がなくてもエラーを返す場合がある //なぜ文字列???????????????????? aaaaaa //↑なぜかidを持っていないユーザがいる…ので一応
43. 43 // 見た目に影響がなくてもエラーを返す場合がある //なぜ文字列???????????????????? aaaaaa //↑なぜかidを持っていないユーザがいる…ので一応 おか～さ～ん！！
44. 44 //直でいじるのはだめですけどめんどくさいので
45. 45 //直でいじるのはだめですけどめんどくさいので ヤバタクスゼイアン
46. 46 //直でいじるのはだめですけどめんどくさいので ヤバタクスゼイアン パンドラの箱開けちゃったよね
47. 47 //SQL文の作成　あってるか？
48. 48 //SQL文の作成　あってるか？ 信じるか信じないかはあなた次第
49. 49 結論
50. 50 コメントゆえに⼈は苦しまねばならぬ！！ コメントゆえに⼈は悲しまねばならぬ！！ コメントなどいらぬ！！
51. 51 コメントが無くても 理解できるコードを書こう