Javaコードにコメントを追加する - ダミー

このJavaのリストには、サンプルプログラムの拡張バージョンがあります。すべてのキーワード、識別子、句読点に加えて、人間が読むためのテキストがあります。

/ * * "Java for Dummies、6th Edition"のリスト3-6 * * Copyright 2014 Wiley Publishing、Inc. *すべての権利を保有します。 * / / ** * Displayerクラスはコンピュータ画面上にテキスト*を表示します。 * * @author Barry Burd * @version 1. 0 10/24/13 * @ javaを参照してください。ラング。 System * / public class Displayer {/ ** *主な方法は、コードの実行が始まるところです。 * * @param args（第11章を参照）* / public static void main（String args []）{システム。でる。 println（ "私はJavaが大好き！"）; //私？あなたは？

コメント は、プログラム内のテキストの特別なセクションで、人々がプログラムを理解するのを助けることを目的としています。コメントは、良いプログラムのドキュメントの一部です。 <！ Javaプログラミング言語には、3種類のコメントがあります。

従来のコメント：

リストの最初の5行は、

• 従来の コメントを構成します。コメントは/ *で始まり* /で終わります。オープニング/ *とクローズ* /との間のすべてが人間の目のためだけです。 「Java For Dummies、6th Edition」またはWiley Publishing、Inc.の情報はコンパイラによって翻訳されていません。 <！リスト3-6の2行目、3行目、4行目、5行目には、アスタリスク（*）が追加されています。これらのアスタリスクは、コメントを作成するときに必要とされないため、余分と呼ばれます。彼らは単にコメントをきれいに見せます。 行末コメント：

  テキスト// I？君は？リストの

  行末

• コメントです。行末コメントは2つのスラッシュで始まり、タイプの行の最後に移動します。もう一度、コンパイラは行末コメント内のテキストを翻訳しません。 <！ Javadocコメント： javadoc コメントはスラッシュとアスタリスク（/ **）で始まります。このリストには2つのjavadocコメントがあります.1つはDisplayerクラスのテキスト、もう1つはtextというテキストです。

  javadocのコメントは特別な種類の伝統的なコメントです。 javadocコメントは、Javaコードを一度も見ない人が読めるようになっています。しかしそれは意味をなさない。 javadocのコメントをどうやって見ることができますか？

• 特定のプログラム javadoc （何が他にありますか？）は、リスト内のすべてのjavadocコメントを見つけ、これらのコメントを見栄えの良いWebページに変えることができます。この図はページを示しています。 <！ - 1 - >

  Javadocのコメントは素晴らしいです。ここにはいくつかの素晴らしいことがあります：

  Javaコードを見なければならないのは、コードを書くプログラマーだけです。コードを使用する他の人は、自動的に生成されたWebページを表示することによってコードが何をするかを知ることができます。 他の人はJavaコードを見ないので、他の人はJavaコードを変更しません。 （つまり、他の人は既存のJavaコードにエラーを導入しません。） <！他の人がJavaコードを見ないので、他の人がJavaコードの内部動作を解読する必要はありません。これらの人々がコードについて知る必要があるのは、コードのWebページで読んだコードです。

  プログラマーは2つの別々のものを作成しません。ここにいくつかのJavaコードとそのコードに関するドキュメンテーションがあります。その代わりに、プログラマーは1つのJavaコードを作成し、コードの中にドキュメントをjavadocコメント形式で埋め込みます。

  

<！ - 3 - >

• javadocコメントからのWebページの生成は自動的に行われます。誰もが書いた書類は同じフォーマットです。どのJavaコードを使用していても、図のようなページを読むことでそのコードについて知ることができます。それはフォーマットがJavaを使用する人には馴染みがあるからです。