Go言語のコメントの書き方ガイド!1行・複数行コメントの使い分け
生徒
「Go言語でプログラムの説明を書きたいんですけど、どうすればいいですか?」
先生
「それなら『コメント』を使うといいですね。コメントは、プログラムの動作に影響を与えないメモのようなものです。」
生徒
「へぇ、メモが書けるんですね!でも、どうやって書くんですか?」
先生
「それでは、Go言語におけるコメントの書き方を1つずつ見ていきましょう。」
1. コメントとは何か?初心者でもわかる基本のキ
Go言語(Golang)における「コメント」とは、プログラムの中に書く説明文のことです。コメントは、実際にコンピュータが動かすプログラムには含まれず、開発者同士のメモや、自分用のメモとして使われます。
たとえば、「ここでは計算をしています」や「この関数は名前を表示します」など、処理の内容を言葉で残すことができます。コメントは、コードを読みやすくするためにとても大切です。
Go言語では、コメントの書き方が決まっていて、以下の2つの書き方があります。
- 1行コメント(1行だけに書く)
- 複数行コメント(2行以上にまたがって書く)
2. 1行コメントの書き方と使い方
1行コメントは、コードの横や上に短い説明を書きたいときに使います。// という記号を使って、コメントを書き始めます。
書いた行のその部分から右側は、すべてコメントとして扱われます。以下が1行コメントの例です。
package main
import "fmt"
func main() {
// 画面に「こんにちは」と表示します
fmt.Println("こんにちは") // ここでもコメントが使えます
}
このように、//を使えば、その行の途中でも最後でも自由にコメントを書くことができます。
3. 複数行コメントの書き方と使いどころ
複数行コメントは、長い説明や、何行にも渡る注意書きを書くときに便利です。/* で始めて */ で終わることで、囲んだ部分すべてがコメントになります。
package main
import "fmt"
func main() {
/*
このプログラムは、
あいさつのメッセージを表示します。
初心者向けのサンプルです。
*/
fmt.Println("こんにちは")
}
このように、何行にもわたって丁寧な説明を入れることができます。
4. コメントはどう使い分ける?初心者にもおすすめの使い方
「1行コメント」と「複数行コメント」は、状況に応じて使い分けるのがポイントです。
- 1行コメント:コードの横に短く説明を書くとき
- 複数行コメント:最初に全体の概要や注意点などを詳しく書くとき
たとえば、下のようにコード全体の説明を最初に複数行で書き、各行の意味を1行コメントで書くと、とても読みやすくなります。
package main
import "fmt"
/*
ユーザーに挨拶をするプログラム。
シンプルな関数を使って表示します。
*/
func main() {
// あいさつを表示する
fmt.Println("こんにちは、世界!")
}
5. コメントを書くときの注意点とおすすめの書き方
Go言語でコメントを書くときのポイントは次のとおりです。
- 読みやすい言葉で書く:自分だけでなく他人が見ても理解しやすい表現にする
- 簡潔に書く:必要なことだけをシンプルに書く
- 間違った情報を書かない:コードと内容が合っていないコメントは混乱のもとです
また、Go言語ではプログラムの冒頭でパッケージや関数の説明にコメントを書く「ドキュメントコメント」もよく使われます。これも1行コメント(//)を使って書かれます。
// main関数はプログラムの開始点です
func main() {
fmt.Println("Goのコメント、覚えましたか?")
}
6. コメントを無効化してコードを試すときにも便利!
初心者がよく使うテクニックとして、「一時的にコードを止めたいときにコメントにする」という使い方があります。
たとえば、ある処理がまだ完成していない、または一旦外したいというときは、コメントにしておくとあとで元に戻せます。
func main() {
// fmt.Println("ここは後で使う予定です")
fmt.Println("動作確認中")
}
このように、コメントは「説明」だけでなく、「一時停止」のような使い方もできて便利です。