Category:

読みやすいコード、メンテナンスしやすいコード

自分が個人的に読みやすい、メンテナンスしやすいと思うソースコードの特徴を書いてみようと思います。個人の好みも含みます。 言語やアーキテクチャ、プロジェクトにかかわらず、コードレビューの時にはこのような観点でレビューしてます。 モジュール名・クラス名・関数名・変数名からその責務が明確である 基本的に、一つの責務を持つ GOOD: getBook(id: string), updateBook(book: Book) BAD: getAndUpdateBook(bookId: string) その責務がわかるように命名する 英語として成り立ってる(日本語に直訳して意味が通じる) 第三者が見て別の意味に捉えようがない ただし、具体的に説明しすぎず、適宜抽象化する 具体的にしすぎると、処理をちょっと変えるたびに関数名も変更が必要になってしまうし、関数名が長くなりすぎる傾向がある 例: 本リストを Continue Reading

Posted On :