├── LICENSE
└── README.md


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 Ubie Inc.
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Kotlinコーディングスタイル
 2 | 
 3 | あくまでガイドラインです。
 4 | あなたは状況に応じて原則を破ることができますが、その判断は慎重に、そしてコメント等でその判断に至った背景や理由を語ってください。
 5 | 
 6 | スタイルは[ktlint](https://github.com/shyiko/ktlint)に従ってください。
 7 | ただし、人間がいくつか気をつけることがあります。
 8 | 
 9 | ## シンプルに保つ
10 | 
11 | 重要な原則です。
12 | 難しいことはしないで、常にシンプルになるよう心がけてください。
13 | 
14 | 例えば、ネストした制御構文は人類には難しすぎるコードです。
15 | 副作用の扱いも慎重に。
16 | 
17 | publicな拡張関数の導入には注意が必要です。
18 | 
19 | ## テストコードは極めて素直に
20 | 
21 | テストコードでは、DRYにすることに躍起にならないでください。
22 | 同じコードを繰り返してもかまいません。
23 | 素直に、愚直に、単純に。まして何かを抽象化するメリットはほぼないでしょう。
24 | 
25 | * 処理の塊を見つけてもメソッド化する必要はないかもしれません
26 | * リテラルに名前を付ける必要はないかもしれません。何度も同じリテラルを記述しましょう
27 | 
28 | ## 型を明記する
29 | 
30 | 型を明記してください。
31 | ただし、次の場合は例外です。
32 | 
33 | * ローカル変数の型
34 | * テストコード
35 | * Single-expression functionでなく戻り値の型が`Unit`の関数
36 | 
37 | ## Single-expression function
38 | 
39 | Single-expression functionは、そのシグネチャから式の開始までを同じ行に書く必要があります。
40 | `=`や式の開始が、シグネチャの次の行から始まる場合はSingle-expression functionの使用を諦めてください。
41 | 
42 | ```kotlin
43 | // OK
44 | fun printHelloWorld(): Unit = println("Hello, world!")
45 | 
46 | // OK
47 | fun newPerson(
48 |     name: String,
49 |     age: Int
50 | ): Person = Person(
51 |     name,
52 |     age
53 | )
54 | 
55 | // NG
56 | fun findUserByName(name: String): User? =
57 |     userRepository.findUserByName(name)
58 | 
59 | // OK
60 | fun findUserByName(name: String): User? {
61 |     return userRepository.findUserByName(name)
62 | }
63 | ```
64 | 
65 | ## NotNull変換
66 | 
67 | `!!`は使わずに`requireNotNull`を使用してください。
68 | 
69 | ## lateinitは使用しない
70 | 
71 | フレームワークの都合上やむを得ない場合を除き、`lateinit`は使用しないでください。
72 | 
73 | ## ブレースは省略しない
74 | 
75 | 制御構文においてブレース（`{}`）は省略しないでください。
76 | ただし、下記の場合を除きます。
77 | 
78 | * `return`, `break`, `continue`, `throw`のみを本体に含む場合
79 | * else-if
80 | 
81 | ```kotlin
82 | // OK
83 | if ( ... ) {
84 | } else if ( ... ) {
85 | }
86 | 
87 | // also OK
88 | if ( ... ) {
89 | } else {
90 |     if ( ... ) {
91 |     }
92 | }
93 | ```
94 | 


--------------------------------------------------------------------------------