コードの中にコードの解説。コメントの書き方![Go言語入門]

コードは長くなるほど複雑になりますし、書いた日から時間が経つとコードの構造を忘れてしまうものです。他人も利用するコードになれば、その使い方を伝えなければなりません。

そんな時はコードの中に簡潔な解説を書いておくと便利です。しかし、解説文をそのまま書くとエラーになりますので、専用の『コメント』の書き方をご紹介していきます。

コンテンツの転載は固くお断りいたします。

コード例

以下のコードは『Goプログラムの実行方法と画面に文字列を表示させよう!』で紹介したものを書き換えたものです。

文字が灰色になっている部分がコメントです。


package main

import "fmt"

// main関数
func main() {
	fmt.Println("初めてのGo言語プログラム!") // コメント!
	// fmt.Println("コメントだよ!")
	/*
		fmt.Println("これもコメント!")
		fmt.Println("コメントは無視されて実行されない。")
	*/
}

上記のコードを実行すると以下のようになり、コメント部分は処理されないことが分かります。

初めてのGo言語プログラム!

コメントの書き方

コメントの書き方には2種類あり、1行だけか複数行にも対応出来るかです。

1行だけのコメント


fmt.Println("初めてのGo言語プログラム!") // コメント!
// fmt.Println("コメントだよ!")

『//』と書いた後の1行がコメント部分になります。1行だけでサッとコメントを書きたい時に便利です。

複数行対応のコメント


/* fmt.Println("コメントだよ!") */
/*
	fmt.Println("これもコメント!")
	fmt.Println("コメントは無視されて実行されない。")
*/

コメントが複数行になる時は、全ての行を『//』でコメント化するのは面倒ですので、そんな時は『/*』と『*/』で囲うことで、その囲まれた中がコメントになります。

さいごに

コードを黙々と書いていると忘れがちなコメントですが、そのコードは何のためのものなのか、他人が見た時でも分かりやすく、後で見返した時にも分かりやすいようにコメントを書く癖をつけておくのをお勧めします。

また、全てのコードにコメントを入れたり、誰が見てもすぐに分かるようなコードであればコメントを入れる必要はありません。分かりにくい部分に適度に入れておきましょう。