質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.96%

モジュール内クラスへのRubocopの指摘について

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,339

ユーザーランキング総合1位

 背景

Rubyでは、クラスやモジュールの中でもクラスを作成できるので、RailsのActiveRecord::Baseのように、外側のモジュール/クラスを名前空間として使って、クラスを作成できます。

そして、コード品質・読みやすさの向上を図って、Rubocopでチェックを回しています。

そこで、2点気になることがありました。いくらRubocopを入れているからと言え、理由もわからないまま闇雲に従うのも正しい態度ではないと思って、指摘される背景を気にしています。ご教示いただければ幸いです。

 その1

何気なく以下のようなコードを書くと、Rubocopに、「分けて書くように」という指摘をされました。これはどのような背景があっての指摘なのでしょうか。

# ダメ出しされた例
class Foo::Bar
  # 略
end

# こう書いたほうがいい、とのこと
module Foo
  class Bar
    # 略
  end
end

 その2

分けて書いた場合ですが、今度は「クラスコメントがない」という指摘を受けました。ただ、内側はともかく、外側については独自のコードを書かない場面で、何を書けばいいのかわかりません。# :nodoc:で省略してしまってもいいものなのでしょうか。それとも、「こんなことを書いたほうがいい」というものがありますでしょうか。

 バージョン情報

  • Ruby 2.2.4
  • Rubocop 0.37.2
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

1について興味があったので調べてみたところ、以下に辿り着きました。

https://gist.github.com/gshaw/4adbebcba6ac954636e9

class Foo::Bar だと、Foo が定義されていない場合に NameError: uninitialized constant Foo が発生するので、それを避けるためかと思います。

ドキュメントについての習慣は私はあまり詳しくないので、すいませんがコメントは控えようかと思います。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/08/10 10:02

    2番めについてですが、外側のモジュールが純粋に囲っているだけで、外側のモジュールに直属するコードがない場合には、特に警告されませんでした。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.96%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る