コーディングにおいて、コメントは将来のために考えを保存する数少ない方法の 1 つです。これらは、コード スニペット全体を理解するのに役立ち、数日前に作成した内容を理解しようとする次の開発者にも役立ちます。 Visual Studio Code (VS Code) を使用している場合は、毎回コメント区切り文字を精力的に入力する必要はありません。 VS Code には、時間を数秒 (場合によっては数分) 節約するショートカット機能が組み込まれています。
クイック VS コード コメント ショートカット
お急ぎの方は、ゴールデン チケットをご利用ください:
- 単一行のコメントの場合は、Windows または Linux では Ctrl + / キーの組み合わせを使用するか、Mac では Cmd + / を使用します。
、
- ブロック コメントの場合は、代わりに Windows または Linux では Shift + Alt + A を、Mac では Shift + Option + A を使用してください。
、
- コードをコメントアウトするには、Windows では Ctrl + K + C を押すか、Mac では Cmd + K + U を押します。
、
ほとんどのプログラマーはたくさんコメントします。そして、実際のコメントを残すだけではなく、おそらくもっと重要なのは、コードをコメントアウトしたりコメント解除したりすることになるということです。これは、テスト、実験、デバッグに有効です。
これをより快適にするためのショートカットがあります。これらにより、ナビゲーションと変更が迅速化され、コーディングの勢いを妨げることなくコメントを切り替えることができます。
基本を超えたコメント
基本的なショートカットは本当に素晴らしいものですが、VS Code のコメントにはそれ以上の機能があります。さらに詳しく見てみましょう:
コメントの切り替え
VS Code のコメント ショートカットの最も優れた点は、切り替え機能です。気が変わった場合 (またはデバッグ中) に、各コメント マーカーを手動でいじったり削除したりする必要はありません。代わりに、同じショートカットを使用するだけです。同じキーの組み合わせを使用すると、コメント付きコードとコメントなしコードをすばやく切り替えることができ、最も必要なときに整理された状態を保つことができます。
複数行のコメント化
長いコード ブロックをミュートする必要がある場合、または広範で詳細なコメントを残す必要がある場合、コメントを 1 行ずつ追加するのに時間を費やす必要はありません。したがって、代わりに、非アクティブ化する行を選択し、コメント ショートカットを使用して、VS Code が各行にコメントを挿入できるようにすることができます。
ネストされたコメント
場合によっては、区切り文字が適切に一致していない場合、コード ブロックにコメントを挿入すると、予期しない結果やエラーが発生する可能性があります。ここで、Visual Studio Code の Intellisense が役に立ちます。すでにコメントアウトされているブロック内でもコメントの書式が調整されるため、ネストされたコメントと競合することはありません。
コメントをスーパーチャージするための拡張機能
VS Code は、開発者が最高の拡張機能を提供するためのプラットフォームとして機能するオープンソース エディターです。マーケットプレイスには、コメントするときにさらに強力で実用的な拡張機能がたくさんあります。
より良いコメント
コメントはコーディングの小さなオプションの部分のように思えるかもしれませんが、コメントを使用する創造的な方法はたくさんあります。の より良いコメント 拡張機能を使用すると、コメントをアラート、クエリ、TODO、その他のカテゴリに分類することで、散りばめられたコメントに目的と明確さを加えることができます。さらに、色分けにより視認性と整理性が向上します。コメントは、コードをよりわかりやすく、親しみやすいものにするためのガイドポイントおよび区切り文字になります。
コメントアンカー
コメントアンカー コード内のセクションや重要な箇所をピンポイントで区別することで、コードをしっかりと把握できます。この拡張機能を試してみると、正確なメモやコメントを迅速に見つけることができます。プロジェクトが膨大で、コードが詰め込まれていて従うのが難しい場合、これによりプロジェクトがはるかに理解しやすくなる可能性があります。
ポリッシュコード
ポリッシュコード コードとコメントを、ソーシャル メディアに最適な、視覚的に興味深い、読みやすい、共有可能な画像に変換します。サイズ変更、色分け、背景の変更などを行うことができます。読みやすさが向上し、チームメイトが共同作業して洞察をより簡単に共有できるようになります。
なぜコメントするのか？
コメントは単にチェックを入れるだけの作業や、口うるさい人が行う任意の雑用ではありません。それはコーディングに不可欠な部分です。その理由は次のとおりです。
vizio テレビの電源がオフになったりオンになったりする
明瞭さ
プログラマーは、理解しにくいものを理解できるようにしようとします。機能するコードを書くことは、理解しやすく従うのが簡単なコードを書くことよりも簡単な場合があります。コメントは開発者の羅針盤であり、コードが軽くて若いものであっても、密度が高く成熟したものであっても、コードの範囲をナビゲートするための貴重な助けとなります。複雑なアルゴリズムや難解なビジネス プロセスを扱っている可能性があります。いずれにせよ、コメントは、複雑な海の中で馴染みのある手がかりを提供します。
コラボレーション
コメントは個人開発者にとって便利です。ただし、チームとして作業する場合、プロジェクトを少しでも前進させたい場合にはこれらが必要です。共同作業では、コメントを使用することで、対話していないときでも複数の開発者がシームレスに共同作業できるようになります。チームメンバーはコードについて説明し、意思決定の背後にある思考プロセスと推論を共有できます。これは、全員がプロジェクトに対しても、お互いに対しても同じ認識を持てるようにする橋渡しの役割を果たします。
デバッグ
古いコードをもう一度見直したり、デバッグしようとして困惑したりした場合、コメントが救いになります。過去のロジックと思考プロセスの記録が保存されているため、ロジックに欠陥がある可能性が指摘され、バグの原因に戻る可能性があります。過去の状況を思い出させることで、問題のある変更を元に戻し、古いコードを最適化し、軌道に戻ることができます。
効果的なコメントをするためのヒント
これで、コメント ショートカットの使用方法、便利な追加拡張機能の使用方法、コメントが最も役立つシナリオの理解方法がわかりました。あとはコメントのベスト プラクティスを検討するだけです。そうすれば、コメントのコーディング コースは卒業できます。
簡潔にする
簡潔で理解しやすいコメントを残すことには芸術性があります。将来の自分やチームメンバーに正しいアイデアを与えるのに十分な量を残しておきますが、圧倒されるほど多くは残しません。コメントのそれぞれの言葉には目的があり、伝えようとしているメッセージを構築するのに役立つ必要があります。コメントが短すぎるとメッセージが伝わらない可能性がありますが、長すぎると、流し読みしたり混乱したりする可能性が高くなります。
明らかなコメントを避ける
明確でわかりやすいコードを作成する際には、関連性を第一に考慮する必要があります。コードの意味が明らかになるようにすでにコードを記述している場合は、一見してわかることについて言及する必要はありません。可能な限りコードに話させ、コメントを使用して追加のコンテキストを追加したり、新しい視点を提供したりできます。
コメントは「何を」ではなく「なぜ」に使用します
コードは、何が起こっているかという事実を説明します。しかし、コメントはより深いストーリーを伝えることができます。それらは、あなたの決定の背後にある動機と思考プロセスを伝えます。他のアルゴリズムではなくこのアルゴリズムを選んだ理由は何ですか?留意すべき落とし穴は何でしたか?おそらく、多くの人が推奨するコードを試してみたものの、機能しなかったり、パフォーマンスが良くなかったりしたことがあるでしょう。よく練られたコメントを使用すると、単なる指示以上のものを伝えることができます。
コメントを残す
VS Code のコメント機能は、単に便利なだけではありません。これを最大限に活用すると、コードベースの操作性と理解しやすさに大きな違いが生じる可能性があります。賢い拡張機能と徹底した戦略を追加すれば、すぐに傑作のような文書化されたコードを作成できるようになります。
コードを説明するために多くのコメントを残しますか?それとも、壊れたコードや実験的なコードをデバッガーから除外するために主にコメントを使用しますか?以下のコメント欄であなたのストーリーを教えてください。彼らはここに留まります。
