前回、前々回で、概ね言いたいことは言ったので与太話的にはOKなのですが、多くの日本人プログラマが経験するであろう業務アプリの開発を想定した変数の命名について、「アーキテクト」的な補足を行います。
前回、前々回の記事の要点をいうと「命名は主観的になりがちなので、ルールを決めない状況でのレビューは危険」、「初心者は先ずはプログラムを書くことを学習する」ということを言ったのですが、今回の要点は、広域だったり業務用語に対応する変数の命名というのは、「個人の主観ではなくチームとしてきちんと定義しましょう」という話になります。
コーディング規約については既に説明しましたが、一言でいうと「命名についての一般ルール」で主にスタイル(単語の書き方や熟語の書き方が主軸)のルールになるかと思います。
一方で、「プロジェクト用語集」なるものも存在します。これは、プログラマが予め知っておいた方がよい、専門用語や業務用語についての項目と説明があります。
もっとも、実態としては「カバーしている用語の数が少なかったり」「ピント外れ」だったりもありますし、多くのプロジェクトでは「そんなものは存在しない」です。実は「プロジェクト用語集」に準じるものとして、「データベースの定義書(スキーマ)」が挙げられます。例えばECサイトなら、商品テーブル、注文テーブルなどがあり、以下のようになるでしょう。
商品テーブル:Goods
商品ID(id)
商品名(name)
単価(price)
注文テーブル(Orders)
注文ID(id)
注文主氏名(orderer_name)
送付先氏名(shipping_name)
送付先住所(shipping_address)
送付先電話番号(shipping_tel)
税抜価格(sub_price)
税込価格(tax_price)
送料(sipping_fee)
合計価格(total_price)
注文明細テーブル(Order_items)
注文明細ID(id)
注文ID(oid)
商品ID(sid)
個数(number)
税抜価格(price)
(当たり前ですが、細かいところは端折っていますが)、最低限、このような項目があるかと思います。
まったくの初心者の方はついてこれないかと思いますが、送付先とか送料、合計価格などの名称は馴染みがあるでしょう。各々の項目に英語名がカッコ内にあります。大体、この英語名がDBのカラム名(テーブル名とあわせて、グローバル変数名のようなモノ)になります。今回はこの英語名をAIでレビューさせます。
さて、これをChatGPTにかけた結果がこちらになります。
https://chatgpt.com/share/695f48aa-9450-8006-ae08-f7941ab5e69c
上記はChatGPTとのやり取りですが、ChatGPT,Gemini,Copilotでレビューした結果(それぞれの推奨の名前)を表にまとめます(やり取りの詳細は省略します)。
| 元 | ChatGPT要修正 | ChatGPT推奨 | Gemini | Copilot |
| Goods | products | products | products | products |
| name | - | - | - | - |
| price | - | unit_price | unit_price | - |
| Orders | - | orders | orders | - |
| orderer_name | - | customer_name | customer_name | customer_name |
| shipping_name | - | - | - | - |
| shipping_address | - | - | - | - |
| shipping_tel | - | - | - | - |
| sub_price | - | - | - | net_price |
| tax_price | - | - | - | gross_price |
| sipping_fee | shipping_fee | shipping_fee | shipping_fee | shipping_fee |
| total_price | - | total_amount | total_amount | - |
| Order_items | - | order_items | order_items | OrderItems |
| oid | - | order_id | order_id | order_id |
| sid | - | product_id | product_id | product_id |
| number | - | quantity | quantity | quantity |
| price | - | unit_price | price_at_sale | - |
| - | - | subtotal_amount | - | - |
さて、このようにデータベースの定義ができますとおのずと、「これらを扱うプログラム」で上記のカラム名に対応する変数名は、当然カラムの英語名を使うことになります。ORMを使えば自然にそうなりますし、手でSQLを書くことになっても敢えて違う名称にする意味はないだけでなくバグにつながるでしょう。
もちろんですが、これは「ある種の理想論」になります。現実的には「カラムの追加削除や変更」があり、それに伴い、プログラム上の変数名とDBのカラム名が時間と共に徐々に異なっていくこともあるかと思います。それを直すかどうかはまた別問題になります。
レビュー時のプロンプトについて
プロンプトの与え方ですが、私の意見になりますが、このように「関連するものはまとめて問い合わせる」方がよいかと思います。サンプルはDBのテーブル定義になりますができれば全部を与えます。プログラミングの場合(作成したプログラム全体)を渡した方がよいでしょう。
これによりAIが、意図を理解して用語間(変数間)の調整も考えてくれます。
感触になりますが、バイブコーディングが実用化されようとしている現在、このような割と突っ込んだ問い合わせにもAIはちゃんと対応できます。
ちなみに、私の場合のように「ある程度名前が用意できる」人はプロンプトとして、
「致命的な間違いを指摘してください」、「海外でも通用する名前を提案してください」
とかにすれば良いかと思いますし、まったく名前が思いつかない人は
「英語名を提案してください」
とすればよいでしょう。
AIの評価について
表を見ますと
・致命的なもの、誤字(sipping_fee)
・不適切なもの(Goods, orderer_name, sub_price, tax_price, number)
・推奨されるもの(price → unit_price)
があります。命名は主観と書きましたが、AIも同様に個性があるようで微妙に違うのもがあります。これらをどう処理するかは、話し合って決めることになりますが、基本的には、誤字や誤訳のように致命的なものを直せばよいかと思います。
ちなみに、tax_priceですが、表には出ていませんが、price_with_taxやgross_priceがあるのですが、そもそも「税込価格」という直接の対訳が無いようです。この対訳が無いという判断はAIではちょっと厳しいかもしれません。このあたりは命名を行う人の英語力ということになります。要はprice_with_taxのようにいかにも説明的な訳だったり、gross_price(合計金額)のように漠然とした訳を見たときに、『「税込価格」というのを海外ではあまり使わないな』と判断するのですが、これはこれで業務知識と英語力が問われるところです。
日本の場合、
・税率の違い(8%、10%)
・外税表示、内税表示がある
などがあります。海外でのこのようにしている国もあるのかもしれませんが、英語の名称(いかにも説明的な訳)を鑑みるとどうも税込価格と税抜価格をいちいち用語として区別することがないように感じられます。これらを踏まえて、ChatGPTと対話してみました。
https://chatgpt.com/share/695f63c1-7ef8-8006-a943-9e946dfce54c
完璧ではないですが、税込価格、税抜価格の候補として、
price_including_tax / price_excluding_tax
tax_included_price / tax_excluded_price
price_with_tax / price_without_tax
gross_price / net_price
base_price / total_price
があるようです。「これ!」という一組でなく、いくつもの組み合わせがあるということで、どれにするのかを決めるとともに、「このように変数名に対して複数の候補が考えられるときは、メンバー各位に命名を任せたらばらつく可能性がある」ということもプロジェクトリーダー・マネージャは頭に入れる必要があるかと思います。
まとめますと
・データベースと関連付けられた名称や、グローバル変数等、複数の人間が関与する変数名は予め決めておいた方がよい。
・税込価格など「専門用語」の場合、対訳も専門用語の対訳にした方がよい(ただし常に対訳があるとは限らないので臨機応変にする必要がある)。
・複数の対訳が考えられるときは「どれを使うのかを」決めておく。できれば使わない候補を(使わない変数名)とすると無用な混乱を事前に防ぐことができる。
・人が作るアプリケーションは大体決まっていることがあるので、慣用表現(GoodsではなくProducts)があればそちらを使う
ということが言えるかと思います。
あまり明確に言われていないかもしれませんが、以上のように考えながらスキーマ設計を行ったり、用語集の必要性を考えるのがシステムアーキテクトの仕事の1つになります。