Javaでコメントを書く方法

コーディングするとき、最初に頭に浮かぶのは、作成したコードをコンピューターがどのように処理するかです。ただし、人々があなたのコードをどのように読むかについて考えることも不可欠です。

チームでプロジェクトに取り組んでいる場合でも、自分で何かを構築している場合でも、コードを適切に文書化するための手順を実行する必要があります。そこでコメントが入ります。

コメントは、コンピュータによって無視されるプログラムで書かれた1行または複数行のテキストです。コメントは、自分自身であろうと他の誰かであろうと、コードを読んでいる可能性のある人間にプログラムの意図を説明するために使用されます。

このチュートリアルでは、Javaでコメントを作成する方法について説明し、効果的なコメントを作成するために使用できるいくつかのベストプラクティスについて説明します。

Javaコメント

プログラミングに不慣れな場合は、自分自身に問いかけるかもしれません。なぜコードにコメントする必要があるのでしょうか。コードコメントを書くことが重要である理由はいくつかあります。

コードを書くときは、たとえ誰かがあなたであっても、コードが誰かに読まれるということを認めることが重要です。さらに、あなたのコードを読んでいる人があなたが書いたコードを理解するという保証はありません。

一人で作業している場合、コメントのないコードがあるとイライラし、コードがどのように機能するかを理解するのに時間を費やす可能性があります。ただし、チームで作業している場合、コメントがない場合はさらに混乱を招く可能性があります。他の開発者はあなたのコードについてあなたに尋ねなければならないかもしれません、それは貴重な時間を消費する可能性があります。

全体として、コメントを書くとコードが読みやすくなります。複雑なプロシージャを作成する場合は、コードの横にプレーンテキストを配置して、特定のコード行の背後にある意図を説明すると役立つ場合があります。あなたが書いたコメントは、特にプロジェクトで他の開発者と協力している場合に、将来の参照に役立ちます。

参加者の81％は、ブートキャンプに参加した後、自分たちの技術的な仕事の見通しについてより自信を持っていると述べました。今日のブートキャンプにマッチしましょう。

平均的なブートキャンプの卒業生は、ブートキャンプの開始から最初の仕事を見つけるまで、キャリアの移行に6か月も費やしませんでした。

最高のコメントは、コードの背後にある意図を説明しています。コード行が何をするかを繰り返すのではなく、なぜ特定の方法で何かをしたのですか？効果的なコメントは質問に答え、効率を向上させます。

Javaコメント構文

Javaには、1行のコメントと複数行のコメントの2種類のドキュメントコメントを書き込むことができます。

単一行コメント

インラインコメントと呼ばれることが多い単一行コメントは、コード行の最後に表示されます。

インラインコメントは通常、1行程度続くコードの小さな部分に注釈を付けるために使用されます。

It’s Fridayというメッセージを出力するプログラムを作成しているとします。 コンソールに。コードを追跡するためにコメントを書きたいと思います。使用できるインラインコメントの例を次に示します。

public class FridayMessage {
	public static void main(String[] args) {
		System.out.println("It's Friday!"); // prints "It's Friday" to the console
	}
}

インラインコメントは、特定のコード行の背後にある意図を説明する必要がある場合にのみ使用してください。多数のインラインコメントを含むコードは、すぐに読みにくくなる可能性があります。

コメントを書くときの目標は、コメントの背後にある意図を説明することであることに注意することが重要です。上記の例では、コードの機能を簡単に理解できるため、コメントはあまり役に立ちませんでした。ただし、より複雑なコード行がある場合は、コメントが必要になる場合があります。

複数行のコメント

複数行のコメントは、ブロックコメントとも呼ばれ、コードのセクションを説明するために使用されるコメントです。複数行のコメントは複数行続き、通常はファイルの先頭またはコードのブロックが始まる前に配置されます。

複数行のコメントは/*で始まります */で終わります 。 Javaソースファイルの複数行コメントの例を次に示します。

/*これは複数行のコメントの例です。

以下のコードは、It’s Friday!を出力します。 コンソールに。

* /

public class FridayMessage {
	public static void main(String[[ args) {
		System.out.println("It's Friday!");
	}
}

この例では、コメントはコードの最初の3行に表示されます。

多くの場合、ファイル自体の詳細をメモするために、ファイルの先頭に複数行のコメントが使用されます。たとえば、複数行のコメントには、ファイルの作成者、ファイルのバージョン、および同様の情報に関する情報が含まれる場合があります。

テスト用のコメントコード

コメントは、文書化の方法として機能するだけでなく、ソフトウェア開発のテストおよびデバッグ段階でコードが実行されないようにするためにも使用されます。コーダーはこれをcommenting out code.と呼んでいます。

例外を発生させたプログラムを作成しているとします。何が間違っているのかまだわからないので、コードの一部をコメントアウトして、問題の原因を突き止めたいと考えています。コード行をコメントアウトするために使用されるコメントの例を次に示します。

class FridayMessage {
	public static void main(String[[ args) {
		String day_of_the_week = "Friday";
		// System.out.println("It's " ++ day_of_the_week);
	}
}

この例では、System.out.printlnで始まるコード行をコメントアウトしています。 。私たちのコードはエラーを返し（1つではなく2つの++を使用したため）、エラーの原因を突き止めながらコードをコメントアウトしました。

プログラムのロジックを分析する場合は、コードをコメントアウトすることが特に役立ちます。このような状況では、最も効率的なものが見つかるまで、コードの複数の反復をコメントアウトすることができます。その後、古いコードを削除できます。

テストとデバッグの段階でのみコードをコメントアウトする必要があります。コメントアウトされたコードを最終的なプログラムに残すと、他の開発者が混乱する可能性があり、コードが読みにくくなります。

結論

Javaには、1行（またはインライン）コメントと複数行（またはブロック）コメントの2種類のコメントがあります。これらのコメントは、コードを文書化するために使用され、ソフトウェア開発のテストおよびデバッグ段階で役立つように使用することもできます。

あなたのコードにコメントする時間をとることはあなた自身とあなたのコードを読んでいるかもしれない他の誰にとってもあなたの仕事をより読みやすくするでしょう。そして最後に、最良のコメントは、コードの背後にある意図を説明するものであることを忘れないでください。

これで、プロのようにJavaでコメントを書き始める準備ができました！