Help us understand the problem. What is going on with this article?

privateメソッドとインデントのスタイル

More than 1 year has passed since last update.

はじめに

この記事は書籍「プロを目指す人のためのRuby入門」に掲載できなかったトピックを著者自らが紹介するアドベントカレンダーの15日目です。
本文に出てくる章番号や項番号は書籍の中で使われている番号です。

今回はprivateメソッドとインデントのスタイルをいくつか紹介していきます。

必要な前提知識

「プロを目指す人のためのRuby入門」の第7章まで読み終わっていること。

privateメソッドとインデントのスタイル

privateキーワードとインデントのさせ方(コーディングスタイル)についてはいくつかの流派があります。1つは本書のようにprivateキーワードもメソッドの定義も同じインデントの深さで定義するスタイルです。

class User
  private

  def foo
  end
end

2つ目はprivateキーワード以下のメソッド定義でインデントを1段深くするスタイルです。Ruby on Railsで自動生成されるコードはこのスタイルです。

class User
  private

    def foo
    end
end

3つ目はprivateキーワードのインデントを1段浅くするスタイルです。

class User
private

  def foo
  end
end

Rubyには公式のコーディングルールがないので、どれが正解とは言えません。「メソッド名はスネークケースで書く」のようなルールはかなり一般的ですが、privateメソッドとインデントのスタイルについては人によって好みがわかれやすいところです。また、好みだけでなく、巨大なクラスになると自分が今見ているメソッドがpublicかprivateか判断しづらいので、2つ目のスタイルのようにインデントの深さで判断したい、という目的も出てくるかと思います。不毛な議論を避けるため、みなさんもチームで開発する際はチーム内で予めコーディングスタイルを決めておいた方がよいでしょう。

ちなみに「プロを目指す人のためのRuby入門」では最初に示した「privateキーワードもメソッドの定義も同じインデントの深さで定義するスタイル」を使っています。

次回予告

次回はメソッド定義と同時に公開レベルを設定する方法を紹介します。

jnchito
SIer、社内SEを経て、ソニックガーデンに合流したプログラマ。 「プロを目指す人のためのRuby入門」の著者。 http://gihyo.jp/book/2017/978-4-7741-9397-7 および「Everyday Rails - RSpecによるRailsテスト入門」の翻訳者。 https://leanpub.com/everydayrailsrspec-jp
https://blog.jnito.com/
sonicgarden
「お客様に無駄遣いをさせない受託開発」と「習慣を変えるソフトウェアのサービス」に取り組んでいるソフトウェア企業
http://www.sonicgarden.jp
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした