07.コメントを残す方法を知る

※無料で読めます

プログラミング未経験でも大丈夫？

コーディングにメモを残せる？

java でコメントを書く方法は？

コメントの意味は？

初めてjava を学習してみようという方/javaでコーディングできるけどやり方がいまいちわからない方に向けた記事です。

プログラミング言語の学習は、大きく2種類あると感じています。

1. その言語でのコーディングのやり方/ルールを知る

2. コーディングでやりたいことを実現するための方法を知る

それぞれ他のもので例えてみると、

料理 ⇒ 1. レシピの読み方/材料の数え方　2. 食材の切り方/火加減の種類

算数 ⇒ 1. 数の概念　2. 計算の仕方

野球 ⇒ 1. ゲーム進行　2. ポジションの役割/バットの振り方/ボールの投げ方

07以降では、この 「２」の内容に関してまとめていきます。

もちろん、全て覚えることで効率的にやりたいことの実現ができます。
ですが、必須ではありません。

忘れたら、もう一度見返せば良い。

何かを見ながらコーディングを進めることは悪いことではありません。

アジェンダ

それでは、いつものように私なりの言葉で、読んでいて眠くなることがないように、タイトルなども工夫していきます。

今回のゴール
・コーディングしたものに、メモを残せる
・コーディングしたものの、説明書を書ける

1. その記憶を永遠に刻む

これを読んでいる皆さんも、お仕事であったり、勉学であったり、家事だったり。様々なことをやりつつ、プログラミングの学習もされていることと思います。本当にお疲れ様です。

ずっとプログラミングのことを考えていたり、記憶力が良いのであればそれに越したことはないのですが、凡人である私は無理です。

私はプログラミングを生業としていて、コーディングもしていますが、書いたコードは数日後には忘れます・・。エビングハウスの忘却曲線 です(少し言い訳)。

一か月後には、そのコードを書いた理由はほぼ覚えていません…。
（忘れていて見返した時に、「過去の私、よくやった！！」と思うこともあるくらいです）

「メモを取っておくと良い」とよく言われますが、コーディングをしていて、付箋などにメモを書いていてもあまり効率的ではありません。

「XX行目は○○をやっている」「次からはXX行目から△△を作る」

なんて、一行でも書いていたら行番号がずれます。

ですので、コード上にメモ、コメントを残しておきましょう。
使い方は、下記になります。

// 一行、メモみたいに書くなら、こちらを使う

/*
複数行でコメントをしたい場合は、こちらを使う
*/

コード上に書いておけば、忘れることも行数がずれてしまうということもありません。

2. 一から十まで知る必要はない

実は、コメントにはもう一つ種類があります。javadoc というものです。

簡単に言うと、メソッドやクラスの取扱説明書 です。
少し複数行のコメントと似ているのですが、下記の書き方になります。

/**
 * @param callName helloと声掛けをする
 * @return 声掛け言葉
 */
public String hello(String callName) {
  return "Hello! " + callName + "!!";
}

vscode でコーディングをしている場合は、
「 /** 」とメソッドの上部で入力すると、
「javadoc のコメントを作りますか？」と表示されるので、
Enterを押すと自動的に書いてくれます。

・ @param は、引数の説明
・ @return は、戻り値の説明
・ @throws は、発生し得る例外の説明

他にも「@」とつくものがありますが、この3つが頻出タグ です。

さいごに

やれることが劇的に増えるという内容ではなかったですね。
でも、コメントはとても大事です。

複数人で作業をしている場合、引継ぎの役割も果たします。
個人で作業をしている場合、思い出す手間を減らせます。

変数名やクラス名をつけるのに自信がない場合は、
javadoc や コメントを書くことで、そのデメリットを補うこともできます。

コメントをうまく活用して、他の人と差をつけてみましょう。

次回、「絶対変えてほしくない値がある時にどうするべきか」に関して説明をしていきたいと思います。よろしければご覧になってください。

有料パートに関して
・今回の記事のまとめを書いています
・ほかの人と差をつけるための具体的な使用方法やコツを書いています

目次に戻る