> For the complete documentation index, see [llms.txt](https://kent-and-co.gitbook.io/first-step-js/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kent-and-co.gitbook.io/first-step-js/javascript-woiteiku/no/komento.md).

# コメント

プログラムで、何の処理をしているのか等をコメントに入れることがある。\
プログラミング言語によって使える物は異なるけど、JavaScript ではどうすれば良いのか確認しておこう。

## 一行コメント

単純に `//` を書く。そうすると改行までがコメントとして処理される。

```
// ココがコメントになる
```

## 複数行コメント

ここからここまでの形式で書く。\
`/*` で始めて、 `*/` で閉じる。CSS といっしょ。

```
/*
ココがコメントになる
 */
```

これでオッケー。

時によって、行頭を揃えるためなどに次のような書かれ方をする事もある。

```
/*
 * ココがコメントになる
 * ココもコメント。
 * まだまだ続くコメント。
 * どうでもいいコメントでも構わない。
 */
```

## 参考: JSDoc

JSDoc という書き方があって、それを使うと、どんな関数なのか等を記述しやすくなっている。\
関数の引数がどんな物なのかだとか、返り値（結果）がどんな物なのかと言う事を書いておける便利な記法。

そのときにもコメントの記述を利用するので、以下のような感じになる。

```
/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
```

最終的に jsdoc コマンドを利用して、関数等の情報をまとめた資料を出力することができるのでとても便利。\
長いプログラムを書くようになったら是非活用しておきたいところ。