40
44

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

【Java】コメントの種類と書き方

Last updated at Posted at 2017-08-11

:beginner:新人研修のソースレビューで毎回指摘してるので、新人さん向けに整理してみました:beginner:

Javaのコメントの種類

  • 1行コメント
  • 複数行コメント
  • JavaDoc

1行コメントの書き方

// コメント

eclipseだと ctrl + /で入れたり消したりできる。

複数行コメントの書き方

/*
* 先頭のアスタリスクは1つ
* comment
*/

JavaDoc

/**
 * クラスやメソッドの説明
 * 先頭はアスタリスク2つです。
 */

前述した2つとは性質の違う特別なコメント。
JavaDocコメントはjavaのコマンドを使ってドキュメント化できる=リファレンスマニュアルになる。
そのため、いろんなタグが使える。
マニュアルなので、ソースコード内でちょっとした説明を書くときには使ってはいけない。

タグの例

タグ 説明
@param パラメータ(引数)についての説明。
@return 戻り値についての説明。
@author プログラムの作成者についての説明。
@throw 投げられる例外についての説明。
40
44
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
40
44

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?