数値リテラルを目立たせてマジックナンバーを阻止しよう

プログラム内に書かれた、
プログラマ本人にしかわからない数字を
マジックナンバーといいます。

マジックナンバーは
他人または未来の自分がコードを読むときに、
プログラムの理解を困難にさせるものです。

一般に、マジックナンバーは避けるべきです。

なぜなら、複数箇所に
同じ数値が書かれている場合、
その数値を変更する場合は
すべてを変更する必要があるからです。

たとえば、税込価格を計算するために
数式に直接 1.08 と書いたら、
それはマジックナンバーです。

将来消費税率10%になったときに
1.1 に書き換える必要があるからです。

マジックナンバーを阻止するためには、
数値をハイライトするのがいいです。

そこで、 highlight-numbers.el が役立ちます。

マイナーモード M-x highlight-numbers-mode を有効にすると、
数値をハイライトします。

プログラミング言語固有の
数値リテラルにも対応しています。

• c-mode
  
• c++-mode
  
• emacs-lisp-mode
  
• clojure-mode
  

以上のメジャーモードと派生モードでは、
言語固有のハイライトを行ないます。

たとえば、lisp-interaction-modeは
emacs-lisp-modeの派生モードですので、
emacs-lisp-modeの数値リテラルをハイライトします。

Fig1: before

Fig2: after

(package-initialize)
(setq package-archives
      '(("gnu" . "http://elpa.gnu.org/packages/")
        ("melpa" . "http://melpa.org/packages/")
        ("org" . "http://orgmode.org/elpa/")))

M-x package-install highlight-numbers

M-x package-install package-utils (初めてアップグレードする場合のみ)
M-x package-utils-upgrade-by-name highlight-numbers

本サイト内の関連パッケージ

• highlight-defined - Syntax highlighting of known Elisp symbols