javadocの@seeタグの記述方法を現役エンジニアが解説【初心者向け】

javadocの@seeタグの記述方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。

そもそもJavaについてよく分からないという方は、Javaとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプJava講座の内容をもとに作成しています。

 

 

目次

• javadocとは
• @seeタグとは
• @seeタグの記述方法
• @seeタグと@linkタグの違い
• 実際に書いてみよう
• まとめ

 

javadocとは

javadocとは特定のルールで記述することでJavaプログラムについて説明するドキュメントを自動で作成する仕組みのことです。

jdkに標準搭載されている機能で、クラスやメソッドの上にルールに従いコメントを記述し、ドキュメントを作成するためのコマンドを実行することで作成されます。

javadocを作成する時は以下のコマンドを実行します

javadoc ファイル名

実行するとjavadocファイルを作成することができます。javadocは「/** */」のコメントに記述することでjavadocコメントであると認識されます。

javadocの中でも@は特殊なコメントという扱いになります。

 

[PR] 未経験からWebエンジニアを目指す方法とは

@seeタグとは

@seeタグはjavadocの中で関連項目として外部リンクやテキストを表示させたり、他のフィールドやメソッドなどへの参照リンクを貼り付けることができます。

クラスやメソッド、フィールドの説明の補足などで使うことができます。

 

@seeタグの記述方法

@seeは以下のように記述することができます

/**
 *
 * @see テキスト
 */

javadocコメントの中で@seeを記述後その右に関連項目となるリンクやテキストを作成することができます。

 

@seeタグと@linkタグの違い

同じようにリンクを貼ることができるタグとして@linkタグがあります。

@linkタグと@seeタグの違いですが@linkタグは他のクラスへのリンクを貼ることができますが@seeはそれ以外にも外部リンクを貼ることができます。

 

実際に書いてみよう

では実際に@seeタグを使ってjavadocを書いてみましょう

ソースコード

package test;
/**
 *
 * @see こんにちは
 * @see <a href="https://techacademy.jp">techacademy</a>
 */
public class Main {
  public static void main(String[] args) { }
}

 

実行結果

windowsだとコマンドプロント、Macだとターミナルで以下のコマンドを実行します

javadoc Main.java

するとMain.javaが保存されているフォルダにjavadocのファイルが格納されます。javadocファイルを開くと以下のように表示されます。

関連項目の項目に今回記載した@seeの内容が表示されていることが確認できます。

 

まとめ

この記事ではjavadocの@seeについて解説しました。

 

監修してくれたメンター

メンターSさん システムエンジニアとしてこれまで行政システムや医療用システムの保守、開発に携わりました。 JavaやPython、PHP、Kotlinなど様々な言語での開発経験があります。 TechAcademyではJavaコース、Pythonコース、AIコースなど7コースを担当しています。

 

 

TechAcademyでは、初心者でもJavaやServletの技術を使ってWebアプリケーション開発を習得できるオンラインブートキャンプJava講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。