Blog - LINE ENGINEERING

TAG ARCHIVES: CodeReadability

Code Review Challenge 5問目解説
Hidetsugu Tamaki / Ralph2022-12-09
LINEのAndroidアプリを作っています。
こんにちは。コミュニケーションアプリ LINE のクライアントを開発している玉木です。この記事では、DroidKaigi 2022 の企業ブースで行った Code Review Challenge の 5 問目の解説をします。Code Review Challenge についてはこちらを参照してください。出題タイトル: Coroutine's hard-to-understand trap that is easy to use for us 5 問目では、以下のようなコードが出題されました。 class MyContentProvider : ContentProvider() { private val singleThreadCoroutineDispatcher: CoroutineDispatcher = Executors.newSingleThreadExecutor().asCoroutineDispatcher() // Do not request again if succeeded once. privat
Code Review Challenge 4問目解説
Yuki Ando2022-12-09
iOS/Androidエクスペリエンス開発チーム
こんにちは。コミュニケーションアプリ LINE のクライアントを開発している安藤です。この記事では、DroidKaigi 2022 の企業ブースで行った Code Review Challenge の 4 問目の解説をします。Code Review Challenge についてはこちらを参照してください。出題タイトル: What layout state class was really needed? 4 問目では、以下のようなコードが出題されました。 data class StickerLayoutState( val stickerID: StickerID, val stickerName: String, val stickerImage: String, val stickerType: StickerType, val creatorName: String, val creatorImage: String, val reviewPageIndex: Int, val reviewPageTo
Code Review Challenge 3問目解説
Ishikawa Munetoshi2022-12-09
Developer Experience Development
こんにちは。コミュニケーションアプリ LINE のクライアントを開発している石川です。この記事では、DroidKaigi 2022 の企業ブースで行った Code Review Challenge の 3 問目の解説をします。Code Review Challenge についてはこちらを参照してください。出題タイトル: Truth in deep nests 3 問目では、以下のようなコードが出題されました。 class ProfileImageRepository( private val context: Context, private val metadataDao: ProfileImageMetadataDao = ProfileImageMetadataDao(), private val apiClient: RemoteApiClient = RemoteApiClient(context), private val ioScheduler: CoroutineContext = Dispatchers.IO ) { pri
Code Review Challenge 2問目解説
Kenichi Ikenaga2022-12-09
LINEコミュニケーション基盤開発チーム
こんにちは。コミュニケーションアプリ LINE のAndroidクライアントを開発している池永です。この記事では、DroidKaigi 2022 の企業ブースで行った Code Review Challenge の 2 問目の解説をします。Code Review Challenge についてはこちらを参照してください。出題タイトル: Split by object, not condition 2 問目では、以下のようなコードが出題されました。 class PlayerPresenter( private val loadingView: View, private val playButton: View, private val pauseButton: View, private val progressView: TextView, private val player: Player, private val lifecycleScope: CoroutineScope ) { private var isPlayi
Code Review Challenge 1問目解説
Kazuki Chigita 2022-12-09
LINEコミュニケーションサービス開発チーム
こんにちは。コミュニケーションアプリ LINE のクライアントを開発している千北です。この記事では、DroidKaigi 2022 の企業ブースで行った Code Review Challenge の 1 問目の解説をします。Code Review Challenge についてはこちらを参照してください。出題タイトル : Everything is something 1 問目では、以下のコードが出題されました。 sealed class ContactType { object Friend : ContactType() object Bot : ContactType() } class friend_item_Presenter( private val friendNameProvider: FriendNameProvider, private val coroutineScope: CoroutineScope ) { fun updateViews(itemId: String) { coroutineS
【DroidKaigi 2022】Code Review Challengeの概要と解説まとめ
LINE Engineering2022-10-11
LINE Engineering Blog official account
2022年10月5日(水)〜7日(金)の3日間にわたって開催された、DroidKaigi 2022にてLINEはゴールドスポンサーを務めました。会期中はLINEのブースにたくさんの方にお越し頂き、誠にありがとうございました。本ブログでは、イベント当日2日間実施した「Code Review Challenge」の解説をはじめ、LINEのコードレビューの取り組みや文化についてご紹介いたします。「Code Review Challenge」に参加してくださった方も、そうでない方も、ぜひ本ブログで再チャレンジしてみて下さい。 Code Review Challengeの概要 DroidKaigi 2022のイベント当日、「Bad Code」を「Good Code」に変える、Code Review Challengeを実施しました。この問題は、LINEの社内でおこなっているレビュー会で紹介されたBad Codeの書き方を参考に、エンジニアが一から考えたオリジナルの問題※になります。 2日間、来場される方に何度も楽しんでいただけるように全部で5つの問題を出題しました。 Schedule
コードの可読性についてのプレゼンテーション紹介 vol. 5: "レビューとまとめ" 編
Ishikawa Munetoshi2020-03-13
Developer Experience Development
はじめにこんにちは。コミュニケーションアプリ "LINE" の Android クライアントチームの石川です。この記事は、 "コードの可読性についてのプレゼンテーション紹介" の不定期連載記事の第五回です。前回の記事はこちらです。今回はいよいよ最終回です。第八章の "レビュー" についての解説と、本連載のまとめをします。第八章: レビュー持続可能なソフトウェア開発を行うための一手段として、コードレビューで可読性や頑健性を向上させることは効果的です。コードレビューを行うことで、その時点でのコードの品質向上に寄与するだけでなく、情報共有によるチーム全体の技術力の向上も見込まれます。ただし、コードレビュー自体が開発のボトルネックにならないように気をつけるべきです。この章では、コードレビューにおける注意点を、レビューを依頼する側とレビューをする側の両方の観点から解説します。なお、本記事ではレビューツールとして GitHub を使うことを想定しています。GitLab や Gerrit 等、他のコードレビューツールを使っている場合は、 "プルリクエスト" をそれぞれ
- CodeReadability
コードの可読性についてのプレゼンテーション紹介 vol. 4: "依存関係" 編
Ishikawa Munetoshi2020-01-31
Developer Experience Development
はじめにこんにちは。コミュニケーションアプリ "LINE" の Android クライアントチームの石川です。この記事は、 "コードの可読性についてのプレゼンテーション紹介" の不定期連載記事の第四回です。前回の記事はこちらです。今回は、型と型の "依存関係" の話として、第六章と第七章の解説をします。設計やコーディングを行う際、型同士の依存関係というものは避けられません。例えば、ある型を継承する、インスタンスを引数として受け取る・返り値として使う・メソッドを呼ぶなどをした時点で、その型に対する依存関係が発生します。ただし、無計画に依存関係を作ると可読性や頑健性を損なってしまいます。ここでは、依存関係をどのように扱ったらよいかということを、結合度・方向・重複・明示性の四つの観点から解説します。結合度結合度とは依存関係の強さを示す指標です。ここでは、特に避けるべき、もしくは緩和させるべき強さの結合として、内容結合・共通結合・制御結合の３つを取り上げます。それぞれの結合の解決方法の詳細については、プレゼンテーションを参照してください。 1.
- CodeReadability
コードの可読性についてのプレゼンテーション紹介 vol. 3: "状態と手続き" 編
Ishikawa Munetoshi2019-11-27
Developer Experience Development
はじめにこんにちは。コミュニケーションアプリ "LINE" の Android クライアントチームの石川です。この記事は、 "コードの可読性についてのプレゼンテーション紹介" の不定期連載記事の第三回です。前回の記事はこちらです。今回は、一つの型に閉じた話として、第四章 "状態" と第五章 "手続き" の解説をします。第四章: 状態プログラムの実行状態の数やその遷移を減らすことで、プログラム全体の振る舞いが理解しやすくなることがあります。特に、"不正な状態" や "不正な遷移" がある場合、それらを排除することで、可読性と頑健性が大きく向上するでしょう。ただし、状態の削減はあくまでも可読性や頑健性を向上させる手段であり、それ自体を目標にしてはいけないことに留意してください。この章では、可読性と頑健性を向上させる方法として、"不正な状態を削減する" ことと "状態遷移を単純化する" ことの二点について解説します。 1. 不正な状態の削減ここで、二つの変数間の関係として、 "orthogonal/non-orthogonal な関係" という概念
- CodeReadability
コードの可読性についてのプレゼンテーション紹介 vol. 2: "命名とコメント" 編
Ishikawa Munetoshi2019-10-18
Developer Experience Development
はじめにこんにちは。コミュニケーションアプリ "LINE" の Android クライアントチームの石川です。この記事は、 "コードの可読性についてのプレゼンテーション紹介" の不定期連載記事の第二回です。前回の記事はこちらです。今回は、プログラム中に書く自然言語として、第二章 "命名" と第三章 "コメント" の解説をします。第二章: 命名プログラムを書くときは、クラスやリソースなどの様々なものに名前をつける必要があります。その名前が、正確・明確・記述的であると、コードはより読みやすくなります。この章では、どのような名前がコードを読みやすくするかについて、特に型 (クラス, インターフェース, トレイト等)、値 (変数, フィールド, パラメーター等)、および手続き (関数, メソッド, サブルーチン等) に焦点を絞って解説します。ただし、この章で解説している内容はあくまでも一般論であるため、使用する言語・プラットフォーム・プロジェクトによって命名規則が決まっている場合は、そちらを優先してください。ここでは、名前をつける際に重要なこととして以下の三点を
- CodeReadability

1 2