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

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

新規登録して質問してみよう
ただいま回答率
85.50%
Ruby

Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

コーディング規約

コーディング規約とは、コードの書き方についての決め事のことです。 文法のことではなく、そのチームなどの中の約束事としてどのような書き方で行うかを定めるもの。 項目の例として、関数や変数の命名規則、コーディングのスタイル、括弧やインデントの書き方などが挙げられます。

Q&A

解決済

1回答

1962閲覧

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

maisumakun

総合スコア145123

Ruby

Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

コーディング規約

コーディング規約とは、コードの書き方についての決め事のことです。 文法のことではなく、そのチームなどの中の約束事としてどのような書き方で行うかを定めるもの。 項目の例として、関数や変数の命名規則、コーディングのスタイル、括弧やインデントの書き方などが挙げられます。

0グッド

0クリップ

投稿2016/06/27 01:18

背景

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

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

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

その1

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

ruby

1# ダメ出しされた例 2class Foo::Bar 3 # 略 4end 5 6# こう書いたほうがいい、とのこと 7module Foo 8 class Bar 9 # 略 10 end 11end

その2

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

バージョン情報

  • Ruby 2.2.4
  • Rubocop 0.37.2

気になる質問をクリップする

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

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

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

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

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

投稿2016/06/27 02:43

編集2016/06/28 01:00
thinca

総合スコア1864

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

maisumakun

2016/08/10 01:02

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問