書籍『リーダブルコード』を読んでいて、はっとしたこと、なるほどーと感じたことの備忘録的なメモです。
1としていますが、続きがあるかは不明です
p.61 コードの欠陥にコメントをつける
プログラマが使う記法として4つが紹介されていました
- TODO: あとで手をつける
- FIXME: 既知の不具合があるコード
- HACK: あまりキレイじゃない解決策
- XXX: 危険! 大きな問題がある
開発ツールでは検知してくれるのか
TODOは自分も最近はよく使っていて、Visual Studio 2022 や Visual Studio Code, InteliJIDEAではTODOを検知してくれるので、後で検証するのにいいなと思っていました。
他の3つは知らなかったのですが、では、実際にこうした開発ツールでは検知するのかなーと思って試してみました。
もしかしたら、ほかに検知方法があるかもしれないので、知っている人がいたら教えてほしいのですが、とりあえでコメント行にして書いたらこんな感じだったということの紹介です。
ちなみに、Visual Studio 2022はC#、Visual Studio CodeはTypeScript, JAVA、InteliJIDEAはTypeScript, JAVAで試しています。コメントの色が変わっていることで、検知されていることが分かります。
Visual Studio 2022: C#
Visual Studio Code: TypeScript (波線は無視してください)
Visual Studio Code: JAVA
InteliJ IDEA: TypeScript
InteliJ IDEA: JAVA (最後の{}の色が変わっているのはカーソルが当たっているだけです)
結果
Microsoft社製のVisual StudioではTODOのみが検知されました。
Visual Studio Codeは何も検知していないです。当たり前といえば当たり前ですが、拡張を入れると検知するのかもしれません。
JetBrains社製のInteliJ IDEA ではTODOとFIXMEが検知できました。
InteliJ IDEAは本当に使いやすくて、Ecliplseと比較するとその使いやすさは天地の差があると自分では思っているのですが、こうした検知についてもVisual Studioよりできることが分かりました。
これまで、TODOだけを使っていましたが、FIXMEは開発プロジェクトで他人が作ったコードを触るときに重宝する気がします。
近況
最近、記事のアップをしていませんでしたが、C#だけではなく、JAVAやTypeScriptなどに手をだしていて、いろいろと勉強を重ねていました。
まだまだ、記事にできるほどのものではないかなと思っていて、滞っていました。
新しい言語や技術を学び始めるのがとても楽しく、いろいろと手を出しすぎて収拾がつかなくなっています。
落ち着いてきたところで、また記事をアップしていこうと思います。