変数の命名規則についてご意見ください

Question

(タグ名が思いつかなかったので適当につけています。申し訳ありません)

コードの管理点検に適した命名規則やコーディング上のノウハウを知りたいと思っています。

たとえば、ある変数をconと命名すると、ある選択範囲の内部にある変数conを検索して全て一括して名前を変更したいと思った時、もしその選択範囲にsconeという名前の別の変数がいくつか書かれていた場合、一括置き換えを使用するとこれも一緒に変更されてしまうため、一つ一つ置き換える必要がでてしまいます。また、文字が被らないように変数の命名に注意したとしても、constなどの予約語を避けることは難しいです。

私はこれを避けるために、「変数を書くときは、変数の前後に必ず半角スペースを置く」というルールをかしています。すると、検索のとき前後に半角スペース込みで conで検索すると、sconeは検索結果から除外することが出来ます。(半角スペースのおかげでsとeがはじかれるため)

しかし、こういう小手先テクニックが通用しない場面も多々あります(他人のコードを使うときなど)し、忘れてしまうこともあります。

そこで、「のちにコードを管理点検する際に便利になるような変数の命名規則やコーディング上のより確実なノウハウ」を知ることが必要だと思いました。そういったことをまとめた先人のノウハウ的なものがあればと思ったのですが、そういったものはあるのでしょうか？

ご回答いただけると幸いです。

Comments

[dodox86]

> そういったものはあるのでしょうか？

あるかないかで言うと「ある」で終わってしまいます。「コーディング標準 (coding standard)」などで検索してみると良いです。プログラミング言語やフレームワーク、歴史、それを利用する企業の文化、プロジェクトの体制でも異なるので、現状のご質問内容だと少し漠然としていて、もう少し絞る必要があるかもしれません。

[tetatetu]

わかりました。コーディング標準で検索してみて、また質問したいことがはっきりしたら質問しなおそうと思います。ご回答ありがとうございます。

Answer 1

質問に対する回答ではないですが、そもそもの問題として

変数名や関数名などのユーザ定義語を一括置換するのは、IDEのリファクタリング機能を使うのが妥当だと思います。

Comments

[yumetodo]

パンチカードから移行し始めたばかりでスクリーンエディタというものが貧弱だった遥か彼方昔ならともかく、相当昔からこの手の問題は人の手ではなくテキストエディタなどの適切なツールによって解決されるべきですよね。

[HogeAnimalLover]

はい。もっとも、コンパイラ作れるならエディタが貧弱であろうとも、対応方法あるはずですね。

Answer 2

単語を検索する機能はたいていのエディタに備わっています。
vi や emacs なら正規表現で <con> と検索すればいいし、
Visual Studio なら「単語単位で一致するもののみを検索する」というオプションがあります。
エディタは何を使っているかを質問に書かないと、必要な回答が得られないでしょう。
コーディング規約で問題を解決しようと考えるのは見当違いだと思います。

Answer 3

私の知る限り全ての「変数」が存在するプログラム言語では、変数名に使用できる文字が限られています。多くの言語では、アルファベットと数字、いくつかの記号(演算子や他の言語要素と被らないもの)、さらにシンボルの先頭は数字不可、ということになっているでしょう。

なぜ限っているかというと、変数名に使用できない文字を区切りとして、言語処理系が比較的容易にconとsconeを別のシンボルとして認識できるようにしているからです。
例えばCなら、+や;は変数に変数名に使える文字ではないので、+con;という並びがソース中にあれば(そして文字列リテラルやコメント中でなければ)conというシンボルがそこにある、という識別は容易でしょう。言語の側ではかならずしも空白だけが区切りではないです。
(大昔の4kBASIC等でトークン切り出しを極度に単純化した結果単語の前後に空白を必要としたり、言語レベルでwordの並びの区切りを空白としているForthみたいな言語の例もあったりはしますが)

それと同じ規則で検索/置換を行ってやればいい話です。言語側の規則も常識から乖離したものであることは多くはないので、大抵はエディタの検索機能の「単語単位でマッチング」みたいな機能をオンにするだけでconとsconeを弁別できるはず。空白を入れれば目で見た時に演算記号類が埋もれない、という効用はありますから、自分のソースではやりたいならそうしてもいいと思います。けれど、他人のソースをいじる機会に「前後に空白がない」から対応できない、というのはちょっと寂しいです。

(単語単位の検索というものを知らなかった、それだけのことから面倒になっている質問とも思えますが...)

Answer 4

皆様ご回答ありがとうございます。エディタの機能を詳しく勉強したり、コーディング規約についても勉強したいと思います。