コメントとは何なのか、そしてコメントがプログラミングにおいてなぜ重要なのかを見てみましょう。
また、2 つの一般的なタイプのコメントと、15 の異なるプログラミング言語でコメントを記述する方法についても説明します。
プログラミングにおけるコメントとは何ですか?
平たく言えば、コメントはエンドユーザーには表示されないテキストであり、コードを作成する人々の参考になります。
もう少し正式に言えば、 コメントとは 、プログラムがどのように動作するかについて、単純な読みやすい形式で記述したものです。これらは通常、コードを読み進める開発者に追加の明確さを提供する必要がある場所で使用されます。したがって、これによりコードの可読性が向上し、知識の伝達に必要な時間と通信が削減されます。
コンパイラ/インタープリタはコード内のコメントを無視するだけなので、プログラムの最終出力には影響しません。つまり、一言で言えば、コメントはコードの特定の部分についての簡単で読みやすい説明のようなものです。
一般的なコメントの種類
ほとんどのプログラミング言語は 2 種類のコメントをサポートしています。
- 一行コメント
- 複数行コメント/ブロックコメント
名前が示すように、単一行コメントは、短い単一行テキストを追加する必要がある場合に便利です。特定の条件、簡単な説明が必要な定数値。一方、関数に関する説明やその使用方法など、追加する情報が大量にある場合は、複数行の方が効果的です。
ドキュメント コメントなど、他のタイプのコメントもありますが、それはこの記事の範囲外です。
コメントを追加する必要があるのはなぜですか?
「どんな愚か者でもコンピュータが理解できるコードを書くことはできる。優れたプログラマーは人間が理解できるコードを書きます。」 – マーティン・ファウラー
コメントを追加する主な利点は、読みやすさが向上し、プログラムの理解が深まることです。これ以外にも、次のような利点があります。
- コメントを使用すると、同僚や他の開発者でも、長いドキュメントを読まなくてもロジックを非常に簡単に理解できるようになります。
- 小さな疑問に対する開発者間のコミュニケーションの減少
- コメントはコンパイラ/インタープリタによって無視されます。
- オープン ソース ソフトウェアの場合、その特定のプログラムを使用したい何百万もの開発者にすべての機能を説明することはできないため、これらは必須です。
多言語でのコメント
コメントについて、そしてコメントがなぜ役立つのかを学びました。さまざまなプログラミング言語でコメントを追加する方法を見てみましょう。
C/C++ でのコメント
一行コメント
// This is a single line comment in C/C++
複数行のコメント
/* This is slightly long
multi line comment in C/C++ */
Python でのコメント
一行コメント
# This is a single line comment in Python
複数行のコメント
# This is slightly long
# multi line comment in Python
Java でのコメント
一行コメント
// This is a single line comment in Java
複数行のコメント
/* This is slightly long
multi line comment in Java */
Rubyでのコメント
一行コメント
# This is a single line comment in Ruby
複数行のコメント
=begin
This is slightly long
multi line comment in Ruby
=end
Golang でのコメント
一行コメント
// This is a single line comment in Golang
複数行のコメント
/* This is slightly long
multi line comment in Golang */
Haskell でのコメント
一行コメント
– – This is a single line comment in Haskell
複数行のコメント
{- This is slightly long
multi line comment in Haskell -}
Rustのコメント
一行コメント
// This is a single line comment in Rust
複数行のコメント
/* This is slightly long
multi line comment in Rust */
HTML内のコメント
一行コメント
複数行のコメント
CSSのコメント
一行コメント
/* This is a single line comment in CSS */
複数行のコメント
/* This is slightly long
multi line comment in CSS */
JavaScript でのコメント
一行コメント
// This is a single line comment in Javascript
複数行のコメント
/* This is slightly long
multi line comment in Javascript */
R でのコメント
一行コメント
# This is a single line comment in R programming language
複数行のコメント
R は複数行のコメントをサポートしていません。
Erlang でのコメント
一行コメント
% This is a single line comment in Erlang
複数行のコメント
R は複数行のコメントをサポートしていません。
PHPのコメント
一行コメント
// This is a single line comment in PHP
複数行のコメント
/* This is slightly long
multi line comment in PHP */
Perl でのコメント
一行コメント
# This is a single line comment in Perl
複数行のコメント
=begin
This is slightly long
multi line comment in Perl
=end
Kotlin でのコメント
一行コメント
// This is a single line comment in Kotlin
複数行のコメント
/* This is slightly long
multi line comment in Kotlin */
結論
このチュートリアルでは、コメントに関する基本と 2 つの一般的なタイプ (単一行と複数行) について説明しました。また、コメントがなぜ有用であり、必要に応じてコメントを書く必要があるのかについても説明しようとしました。何か新しいことを学べたことを願っています!
探索を続けてください。学び続けます! 👨💻