アノテーションコメントについて調べてみた

Transcript

1. アノテーションコメント について調べてみた TODO ってなんだよ @phpstudy 2019/07/31 秋葉誠一

2. 自己紹介 名前：秋葉 誠一 生年月日：1993/12/17 会社：株式会社ニジボックス 趣味：スノボ、サバゲー、野球(NPB,MLB) @akki_megane

3. まず初めに アノテーションコメントとは？

4. まず初めに TODO FIXME HACK XXX,REVIEW,OPTIMIZE, CHANGED,NOTE,WARNING

5. まず初めに

6. TODO とか、FIXME とかちゃん とつかえてないわー

7. TODO 、FIXME 以外にもある よー(HACK, REVIEW) TODO とか、FIXME とかちゃん とつかえてないわー

8. TODO とか、FIXME とかちゃん とつかえてないわー TODO 、FIXME 以外にもある よー(HACK, REVIEW) あっ、オレFIXMEの使い方間違

   えてた
9. None

10. まず初めに これ誰が決めたの？

11. まず初めに これ誰が決めたの？ ということで調査

12. 調査

13. 調べたこと • 発案者 • 原典 • 公式定義、 (Java、C#、PHP、 Ruby、C++、Go)

14. 調べたこと コーディング規約 Doc系の定義

15. 結果

16. 結果 • 発案者：不明 • 原典：不明 • 公式定義：ちょっとあった

17. 結果 • 発案者：不明 • 原典：不明 • 公式定義：ちょっとあった

18. 結果 • 発案者：不明 • 原典：不明 • 公式定義：ちょっとあった Ruby-style-guide に定義があった

19. 自分の結論

20. • IEDが動作してるから、公式っぽい感じがするがそんなこと はない • 原典的なものはないし、かくあるべきみたいなのもない • ネイティブの方たちが書いていたのが真似されて広まったの では？と推測

21. まとめ

22. • こうでなければ、これは存在しないとか はない • プロジェクトやチームごとのすり合わせが大事 ◦ (我々はネイティブではないので)

23. オレはこうだ！ とかあればご意見お願いします！ 以上です！ありがとうございました！

24. None