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

Kotlinのコメントは、Javaと同じ書き方を引き継いでおり、KDocという説明書きの仕組みも用意されています。この記事では、Kotlinにおけるコメントの書き方と、良いコメントの書き方のコツを解説します。

コメントの書き方

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

複数行のコメントは/* */を使います。

/*
 * ここから先は入力チェックの処理
 * 空文字や不正な形式を除外する
 */

KDocという仕組み

Kotlinには、Javadocに似た「KDoc」という、/** */で始まる説明書きの仕組みがあります。

/**
 * 利用者に挨拶を表示する
 * @param name 利用者の名前
 * @return 挨拶メッセージの文字列
 */
fun greet(name: String): String {
    return "こんにちは、${name}さん"
}

@paramで引数の説明、@returnで戻り値の説明を書けます。IDE(IntelliJ IDEAやAndroid Studioなど)は、このKDocの内容をそのまま関数呼び出し時のヒントとして表示してくれるため、公開する関数にはできるだけ書いておくと、後から使う人(未来の自分も含む)が助かります。

何を書くべきか

Kotlinでは型推論が多用されるため、コメントで型そのものを説明するより、「なぜその設計にしたか」「どんな場面で使う関数か」を書くほうが価値のある情報になります。逆に、コードを読めばすぐ分かる当たり前の内容(例:「iを1増やす」のようなコメント)は、かえって読みにくさにつながるため避けましょう。

TODOコメントで作業を残す

後で対応する必要がある箇所には、// TODO: 説明という形式でコメントを残す習慣が広く使われています。多くのIDEはTODOコメントを自動で一覧表示してくれるため、実装途中の箇所を見失いにくくなります。

// TODO: エラーメッセージを多言語対応させる
fun showError(message: String) { ... }

Kotlinならではの注意点

KDocはJavadocとよく似ていますが、一部のタグの意味や使い方に細かな違いがあります。Javaの経験がある人ほど、無意識にJavadocの書き方をそのまま持ち込みがちなので、公式ドキュメントで正確な書き方を一度確認しておくと安心です。特に、KotlinはNull安全の仕組みを言語自体が持っているため、「nullの場合は〜」といったJavadocでよく見る注意書きの多くは、型(String?など)を見れば分かるようになり、そもそも不要になる場合が多い点も覚えておくとよいでしょう。

まとめ

Kotlinのコメントは//が基本で、公開する関数にはKDocによる説明を書きます。「なぜそうしたか」を中心に書くこと、TODOコメントで作業を残すこと、そしてJavadocとの細かな違いにも注意しましょう。

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

参考書籍(PR)

Kotlinをもっと学びたい方には「やさしいKotlin入門」がおすすめです。

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 を有効にす...
続きを読む