#10 Goで学ぶコメント規約の基本

Goのコメントには、他の言語と共通する書き方に加え、関数の説明として特別な意味を持つ書き方の慣習があります。この記事では、Goにおけるコメントの書き方と、パッケージ全体の説明を書く方法まで解説します。

コメントの書き方

// これは年齢を表す変数 age := 20

複数行のコメントには`/* */`も使えます。ただしGoコミュニティでは、複数行であっても`//`を行ごとに繰り返す書き方の方が一般的です。

関数名から始めるコメントの慣習

Goの公式ガイドラインでは、関数の説明コメントは、その関数名からそのまま始めることが推奨されています。

// Greet は利用者に挨拶を表示する func Greet(name string) { fmt.Println("こんにちは、" + name + "さん") }

この慣習に従うと、`go doc`というコマンドで説明書きを表示した際に、読みやすい形式で整えられます。

パッケージ全体の説明を書く

ファイルの先頭、`package`宣言の直前にコメントを書くと、そのパッケージ全体の説明として扱われます。慣習的に`Package パッケージ名は〜`という書き出しで始めます。

// Package utils は文字列・日付操作の共通処理をまとめたパッケージです。 package utils

型・構造体へのコメント

関数だけでなく、型(struct)にも同じ慣習が適用されます。

// User はアプリケーションのユーザー情報を表す type User struct { Name string Age int }

Goならではの注意点

Goでは、関数名の先頭が大文字か小文字かによって、他のファイルから参照できるかどうかが変わります(大文字なら公開、小文字なら非公開)。公開する関数・型(大文字始まり)には、この慣習に沿ったコメントを書いておくことが特に重視されます。この慣習を守ると、`pkg.go.dev`のようなドキュメント生成サイトでも自動的にきれいな説明文として表示されるため、公開ライブラリを作る際は特に意識しておきたいポイントです。

まとめ

Goのコメントは`//`が基本で、公開する関数・型・パッケージには「名前から始まる説明」を書く慣習があります。この一貫した書き方のルールこそが、Goのコードベースがチーム開発でも読みやすく保たれる理由の一つです。`go doc`やドキュメント生成サイトとの連携も意識しておきましょう。

本ページはプロモーションを含みます。

参考書籍(PR)

Goをもっと学びたい方には「Go言語入門」がおすすめです。

PR

コードを書かずに自動化したい方へ

「学んだけど自分の作業に組み込む時間がない」という方向けに、ダブルクリックで動く Windows専用の自動化ツールをオーダーメイドで作成しています。気になる方は こちらをご覧ください。

コメント

コメントを投稿

このブログの人気の投稿

#25 Rustで学ぶAI API(ChatGPT等)の呼び出し方の基本

ChatGPTのようなAI(人工知能)の機能を自分のアプリに組み込みたいとき、多くの場合は「AI API」と呼ばれる仕組みを使います。APIとは「Application Programming Interface」の略です。簡単に言えば、「あるサービスの機能を、プログラムから呼び出せるようにした窓口」のことです。この記事では、Rustから外部のAI APIをHTTPリクエストで呼び出す基本的な流れを、初心者向けに解説します。 AI APIを呼び出すとはどういうことか ChatGPTを提供するOpenAI社などは、インターネット経由でAIに質問を送り、回答を受け取れる「AI API」を公開しています。これはWebブラウザで検索するときのように、決まった宛先(URL)にデータを送信し、返ってきた結果を受け取る仕組みです。この「データを送って結果を受け取る」通信方式を、HTTPリクエストと呼びます。Rustのプログラムからこの通信を行うことで、自分のアプリの中でAIに質問し、回答を取得できるようになります。 reqwestクレートを使う Rustには標準でHTTP通信の機能は含まれていません。そこで使うのが「クレート」と呼ばれる外部ライブラリです。クレートはPythonのライブラリやJavaScriptのパッケージに近いもので、 Cargo.toml というファイルに追記するだけで簡単に導入できます。HTTP通信でよく使われるのが reqwest というクレートです。 Cargo.toml に次のように追記します(バージョン番号は執筆時点の例なので、実際に使う際は最新版を確認してください)。 [dependencies] reqwest = { version = "0.11", features = ["json"] } tokio = { version = "1", features = ["full"] } serde_json = "1.0" ここで tokio という見慣れないクレートも一緒に入れています。これは「非同期処理」と呼ばれる、通信の待ち時間の間に他の処理を進められる仕組みを扱うためのものです。ネットワーク通信は結果が返ってくるまで時間...
続きを読む

#8 C++で学ぶ文字列操作の基本

C++の文字列操作は、`std::string`という型を使うのが現代的な基本の書き方です。この記事では、C++における文字列操作の基本と、注意しておきたい落とし穴を解説します。 文字列を連結する std::string greeting = "こんにちは、" + name + "さん"; `std::string`同士であれば、`+`を使った連結がそのまま使えます。既存の文字列に追加する場合は`+=`や`append`メソッドも使えます。 greeting += "。よろしくお願いします。"; よく使う文字列操作 name.length() 文字数を調べる(バイト数であることに注意、後述) name.substr(0, 3) 一部分を取り出す(開始位置と長さを指定) name.find("A") 特定の文字の位置を探す(見つからなければ`std::string::npos`) name.replace(0, 2, "XX") 一部分を置き換える 文字列を数値に変換する 文字列を数値に変換したい場合は`std::stoi`(整数)や`std::stod`(小数)、逆に数値を文字列にしたい場合は`std::to_string`を使います。 int num = std::stoi("123"); std::string s = std::to_string(456); 文字列を分割する C++の標準ライブラリには、他言語の`split`のような文字列分割の関数が長らく用意されていませんでした。`std::stringstream`を使うのが伝統的な方法です。 #include <sstream> std::stringstream ss("a,b,c"); std::string item; while (std::getline(ss, item, ',')) { std::cout << item << std::endl; } C++ならではの注意点 C++には、古くからある`char`の配列を...
続きを読む

#16 TypeScriptで学ぶ辞書型(マップ)の基本

TypeScriptの辞書に相当する仕組みは、JavaScriptと同じですが、キーと値の型をあらかじめ決めておけるのが特徴です。この記事では、TypeScriptにおける辞書の扱い方と、用途別の型の選び方を解説します。 型付きのオブジェクト interface Person { name: string; age: number; } const person: Person = { name: "太郎", age: 20 }; キーの型が決まっていない辞書 キーの名前が事前に決まっていない辞書のような使い方をしたい場合は、次のように書きます。 const scores: { [key: string]: number } = {}; scores["太郎"] = 90; 同じ意味を Record というユーティリティ型で簡潔に書くこともできます。 const scores: Record = {}; Mapを使う場合 const person = new Map (); person.set("name", "太郎"); console.log(person.get("name")); Map<string, string> のように、キーと値それぞれの型を指定できます。 Object と違い、キーの数を person.size で正確に取得できる、キーの型を文字列以外にもできるといった利点があります。 値が存在しないかもしれない場合 キーが実在するとは限らない辞書の場合、値の型に | undefined を含めておくと、より正確な型になります。 const scores: { [key: string]: number | undefined } = {}; const value = scores["三郎"]; // number | undefined 型 こうしておくと、存在しないキーへのアクセスがコンパイル時に見過ごされにくくなります。 存在しないキーへのアクセスを防ぐ tsconfig.json で noUncheckedIndexedAccess を有効にす...
続きを読む