Okapi Project   Web technological site for the beginner... Top

わかりやすいプログラムを作ろう!

「オカピ新聞」と出力されるプログラムを作りましたが、まだプログラムとしては不完全です。
プログラムは、動けばそれで良いわけではないのです。わかりやすく、読みやすいプログラムでなければなりません。

ポイント

コメント、インデントを理解します。

題材プログラムの内容

先ほど作成したプログラムにコメントをつけます。

 

プログラムを作成したら、どんな プログラムなのかコメントを記載する必要があります。もし、コメントがないと、どんなプログラムなのか、後で見たときに理解しにくくなってしまいます。
コメントを書くことによって、このクラスがどんな機能を持っているのかソースを見なくてもわかります。

コメントの書き方

右のコメントタイプ1は、1行だけコメントを記述する際は、非常に便利ですが、コメントよりドキュメントを 生成できる JavaDoc には認識されないので、JavaDoc として記述するべき内容は、必ずコメントタイプ2で記載しましょう。

コメント付きプログラム!!

package beginner.lesson01.src03;
/**
 * main メソッドのみを持つクラスです。
 * @author    作成者
 * @version   ヴァージョン
 */
public class TitleOutput {

    /**
     * コンソールに、「オカピ新聞」を出力します。
     */
    public static void main(String[] args) {
        //変数に初期値で「オカピ新聞」と設定します。
        String hensuu = "オカピ新聞";

        //変数をprintln()メソッドに設定しています。
        System.out.println(hensuu);
    }
}
コメントタイプ1 (1行でコメントを書く場合)
// こめんと
コメントタイプ2 (複数行にわたりコメントを書く場合)
/**
 * こめんと
 **/