導入
コメント- もっと簡単にできるように思えますが、なぜ記事全体を書く必要があるのでしょうか。しかし、それはそれほど単純ではありません。上司が言ったように、コードは誰でも書けますが、良いコメントを書くのは難しいです。- 実装コメント (またはコード コメント)。
- コメントを文書化します。
Javaコードのコメント
名前から、このコメントがコードに関連しており、その機能を反映していることは明らかです。コードのコメントは次のとおりです。-
小文字 (つまり 1 行で記述)
// Строчный комментарий System.out.println("Hello, World!"); -
ブロック (つまり、1 行に収まらないため、ブロック全体として記述されます)
/* * Блочный комментарий */ System.out.println("Hello");
コメントを書くたびにひるみ、失敗したような気分になります。」絶対的な真実がないことは明らかであり、コメントが必要な場合もあります。しかし、常に選択肢はあり、不必要なコメントとは戦う必要があります。この章では、珍しいコメント、TODO についても説明します。
// TODO: Добавить World
System.out.println("Hello, ");
ドキュメントへのコメント
ドキュメントのコメントでは、パブリック API について説明します。 APIはアプリケーション プログラミング インターフェイス、つまり、他の開発者がアクションを実行するために使用できるクラスとメソッドです。つまり、これらのコメントは、このクラスやパッケージが作成された理由と、このメソッドやそのメソッドが何を行うのかを説明する必要があります。必要に応じてクラスフィールドを記述することもできます。これはまさに IDE のツールチップに表示されるものであり、JavaDoc として表示されます。例えば：
package test;
/**
* This is a JavaDoc class comment
*/
public class JavaDocTest {
/**
* This is a JavaDoc public field comment
*/
public static final String HELLO_MESSAGE = "Hello, World!";
public static void main(String... args) {
JavaDocTest.greetings();
}
/**
* This is a JavaDoc public method comment
*/
public static void greetings() {
System.out.println(HELLO_MESSAGE);
}
}javadoc -d ./test test この後、ドキュメントの生成プロセスが表示されます。
結論
ご覧のとおり、コメントのような一見単純なものは、実際にははるかに複雑であることがわかります。したがって、コメントに時間をかけてコメントに従うと、コードが改善され、プログラマーとしての価値が高まります。#ヴィアチェスラフ| 他に読むべきもの: |
|---|
GO TO FULL VERSION