公式の和訳(意訳)です.
- IDEでスタイルを設定する, ソースコード構成
- 命名規約
- フォーマット 前半
- フォーマット 後半
- ドキュメントコメント,冗長な記述を避ける(この記事)
- 慣用表現の使用
- ライブラリのコード規約
ドキュメントコメント
ドキュメントコメントが長いときは,/**
だけの行を書き,それぞれの行はアスタリスクを最初に書く.
/**
* This is a documentation comment
* on multiple lines.
*/
短いコメントは1行で書いてもよい.
/** This is a short documentation comment. */
一般的に, @param
と@return
は使わないようにする.
代わりに,パラメータや返り値の説明をドキュメントコメントに直接埋め込んで書く.
パラメータにはリンクを付ける.
@param
と @return
は,それらにとても長い説明が必要で,本文に埋め込んで書くのも難しいときだけ使う.
// Avoid doing this:
/**
* Returns the absolute value of the given number.
* @param number The number to return the absolute value for.
* @return The absolute value.
*/
fun abs(number: Int) = ...
// Do this instead:
/**
* Returns the absolute value of the given [number].
*/
fun abs(number: Int) = ...
冗長な記述を避ける
一般に,あるKotlinコードの記述がオプショナルで,IDEに冗長であることを指摘されているときは,そのコードを修正するべきである.
"明確さのため"だけにコードに不要な記述を残さない.
Unit
関数が Unit を返すときは,返り値の型を省略する.
fun foo() { // ": Unit" is omitted here
}
セミコロン
セミコロンは出来る限り書かない.
String テンプレート
String テンプレートにある変数だけを挿入するときは,波括弧を書かない.
波括弧は,長い式を書くときだけ使う.
println("$name has ${children.size} children")