Upgrade to Pro — share decks privately, control downloads, hide ads and more …

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

akki
July 31, 2019

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

akki

July 31, 2019
Tweet

More Decks by akki

Other Decks in Programming

Transcript

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

  5. まず初めに

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

  9. View Slide

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

    View Slide

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

    View Slide

  12. 調査

    View Slide

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

    View Slide

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

    View Slide

  15. 結果

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

  19. 自分の結論

    View Slide

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

    View Slide

  21. まとめ

    View Slide

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

    View Slide

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

    View Slide

  24. View Slide