VBAにおけるマジックナンバーの扱いについて

Question

- 前提
今回、以下のようなマクロを含むxlsmファイルを作成しました。

1. CSVファイルを読み込み、データを加工してシートに出力
2. 読み込んだデータの一部を加工しCSV出力
3. 作業中のブックの全内容（全マクロ含む）を、マクロ有効ブックとして

コピーし別名保存する

- 疑問点
その後、社内の技術主任の方にコードレビューを依頼したのですが、

Dim i as long
i = Sheet1.Cells(Rows.Count, B).End(xlUp).Row + 1
Sheet1.Cells(i, "B") = "日付"

というようにシートモジュールで指定している列部分がマジックナンバーに
あたるので全てConstで宣言するようにと指摘を受けました。

ただ、今回参照対象がシートモジュールによっては
B列からAA列まであり、１回しか参照していない部分もあります。
この場合であっても列部分がマジックナンバーにあたるので全てConstに
置き換える、というのがいまいち府におちません。
Range(),Cell()の中で利用していれば普通列指定の番号だと分かると
思うのですが、自分の認識はVBAプログラミング的に一般的ではないのでしょうか。

また、Const以外で定数をまとめておく方法等はあるのでしょうか。

Answer 1

技術主任の方がどのような意図で置き換えるように指示したのかは分かりませんので、私の想像でお答えします。

Range(),Cell()の中で利用していれば普通列指定の番号だと分かると

思うのですが、自分認識はVBAプログラミング的に一般的ではないのでしょうか。

確かに**「列番号を指定している」**ことは読み取れるでしょう。

ではプログラムを読んでいる時に、Sheet1.Cells(i, "B")と出てきて**「B列が何を保持している列なのか」**読み取れますか？

例えばこのように定義しておけば**「あぁB列は日付を格納する列なんだな」**って分かりますよね。

Const COL_日付 = "B"
Cells(i, COL_日付) = "2019/2/9"

だから、一度しか使わないとしても無意味ということはないと思います。

もちろん複数回でてくる場合は、将来のバグの元となるので間違いなくしておいたほうが良いでしょう。

あとプロシージャの先頭部分で変化する恐れのある部分をまとめられるので、修正漏れが減らせるというメリットもあるかと思います。（その辺はどの言語でも同じですよね）

ここまでは一般論でして、私が実際にVBAでコーディングする場合は規模が小さいものや、使い捨てが前提のものだと定義せずに使うことが多いです。

社内規定とかがあると思いますので、先輩に従うのが無難だと思います。

以上、ご参考まで。

Comments

[退会済みユーザー]

ご回答ありがとうございます！
確かにおっしゃる通りですね…
本当はこちらもベストアンサーにさせて頂きたいぐらい参考になりました！
今回はそれなりに規模が大きくなっているので定数を定義しておこうと思います。

Answer 2

CSVファイルを読み込み、データを加工してシートに出力

ということなら、テーブルデータということになりますので、
列名（フィールド名）で管理できたほうが分かり安いでしょうね。
自分だけが使うものなら、まだしも、
他の人も使う、メンテナンスもすることがあるということなら、
なおさらマジックナンバーは避けたほうがいいと思います。

自分なら、列名は列挙型変数Enumを使いますね。

Enum ステートメント (VBA) | Microsoft Docs

例えば、シートデータが下記のようなものなら、

||A|B|C|
|:--|:--:|--:|
|1|ID|日付|名前|
|2|101|2/01|AAA|
|3|102|2/02|BBB|
|4|103|2/03|CCC|

下記のような使い方ができます。

Enum ColNum
  ID = 1
  日付 = 2
  名前 = 3
End Enum

Sub Test()
  Cells(5, ColNum.ID).Value = 104 
  Cells(5, ColNum.日付).Value = #2019/02/04#
  Cells(5, ColNum.名前).Value = "DDD"
End Sub

コードの可読性が上がります。
また、コードを書く時も、ColNum. と打つと候補がでるのでそれを選択するだけすみますので、タイプミスも防げます。

また、自作関数を作成するときなど、引数を列挙型で宣言しておくと、
関数を入力時にやはり候補が出るので、便利です。

自作関数に引数の定数リストを表示させる - hatena chips

追記

「VBA Enum」をキーワードにWEB検索したら下記のページが見つかりました。
マジックナンバーを避けるべき理由、Enumの有効な使い方のサンプルが詳細に説明してありますので、
非常に参考になります。

エクセルVBAでシートの列の挿入も簡単に対応できちゃう列挙体の使い方

エクセルVBAでテーブルと列挙体を組み合わせると最強のコードが書ける理由

Comments

[退会済みユーザー]

ご回答ありがとうございます！
こんな方法もあるのですね…勉強になりました。
変数とはなっていますが、実際定数のような扱いができるのは知りませんでした！
また、追記していた箇所でもなぜマジックナンバーになるのかを説明してあり非常に参考になりました！

[退会済みユーザー]

ちなみに、ご説明頂いた内容や補足を見て別途他の質問をさせて頂きましたので
もしよろしかったらお時間ある時にご回答頂けたら幸いです。
https://teratail.com/questions/173692

Answer 3

ご説明の状況については、B列がどんなワークシートでも"日付"の列であれば、サンプルのコードでいいのですが、もしかしたらA列のときもC列のときもありうるので、B列は日付の列であると明示することで見通しをよくして、デバッグしやすくする意図でアドバイスしたと考えます。
そしてこのコードのみならず、今後開発するマクロ処理で、多少列が食い違っていても書き換えやすいように、定数の宣言を先頭にまとめたらすっきりして書き直しやすいことでしょう。

また、手順に説明されているデータとシートマクロの結びつきが、ちょっと気になります。
モジュールマクロとして、ワークシート名を指定してデータを加工できるようにした方が、マクロの汎用性が増すと思います。ベタに、activesheet指定をして、セルを指定して操作していけばいいでしょう。

さらにマジックナンバーを避けるのと同様の考え方で、漢字の変数名を用いたり、Range()に名前を付けておいてCells()メソッドで操ったりするとプログラムの見通しがよくなります。

まあ、結果オーライの考え方もありますが、最初からミスを予防する開発手順を積み上げていった方が安心かつ後戻りがへることになるわけです。

Comments

[退会済みユーザー]

ご回答ありがとうございます！
ちなみにデータシートとマクロの箇所ですが、ブックごとコピーで問題なくできるようになったので記述を削除しました。

今回はベストアンサーにさせて頂いたenum形式で定数を設定していこうと思います。

Answer 4

すでに解決済みですが、、、、、

質問者さんは、勝手に愚痴って、自分だけスッキリした気分になってるけど、
読んだこっちがもやもやしてるので＾＾；

マジックナンバーの話はそういわれたなら、そうすればいいという話なんですが、
（というか、違うことをやってきたら、よりよいコードでもまた叱られそう＾＾；）

というか、それ以前に、コードを読んで、

1）同じことを2度書かない
2）親オブジェクトを明示する
3）2と重なりますが、オブジェクトとオブジェクト変数を理解している？

この辺が凄く気になります。
ちなみに僕が書くと、以下のようになります。

Sub サンプル()
    Dim sFName As String
    Dim wbk As Workbook

    sFName = Application.GetOpenFilename("csv,*.csv")
    Set wbk = Workbooks.Open(sFName)

    With wbk.Sheets(1).UsedRange
        '日付列への処理
        With .Columns("B").Cells
            .Item(.Rows.Count + 1).Value = "日付"
        End With

        '？？列の処理
        With .Columns("G").cells
            '何かの処理
        End With
    End With

    wbk.Close True
End Sub

参考になれば。。。。

あ、間違って2度実行するとどんどん下に書き足しちゃいますね＾＾；
ま、それは別の話で、、、

Answer 5

例えば、Const dateCol = "B"のように書くと思います。