変数名の命名規則 - 不可算名詞を複数形のように表したい。

Question

状況

ファイルをモデル化して以下の２つになった。

• FileInfo ファイルの名前や作成日時を保持するモデル
• FileContent ファイルの中身を持つモデル

※ ファイルの中身はサイズが大きいので、２つのモデルに分割した。

FileInfoを検索し複数のFileInfoを返すメソッドを①とする。
①の命名は< 動詞 > + < 名詞 >の命名規則に従う。

課題

このとき、名詞部分にFileInfoの複数形が来るべきですが、Infoは不可算名詞です。
また、FileInfoにListをつければ複数を意味できますが、そうするとSaerchFileInfoListというようになり、複数のFileInfoを検索するというよりは、FileInfoのリストを検索するというニュアンスになる気がします。
皆様はこのような時、どのような命名をしますか？

Answer 1

皆様はこのような時、どのような命名をしますか？

クラスの命名のアンチパターン

Info って何やねん? Data って何やねん? ImageInfo って Image とはどう違ふねん??

という意見と同じで、基本的にはInfoという命名自体を極力避けます。

ただし、フレームワークでFileInfo クラスという命名がされている場合もあるので、この場合はFileInfoArrayやFileInfoListなど、コレクションの種類がわかる接尾辞を付けるのは次善の策としてはアリだと思います。

そうするとSaerchFileInfoListというようになり、複数のFileInfoを検索するというよりは、FileInfoのリストを検索するというニュアンスになる気がします。

まず、FileInfoListと名付けたコレクションそのものがSearchなりFindなりのメソッドを持つべきだとは思いますが…その場合はFileInfoList.Search(key)でkeyに一致するFileInfoを検索する意味は伝わります。

やむを得ずFileInfoListオブジェクトの外部に検索メソッドを定義する場合、SearchFileInfoFrom(FileInfoList, key)でも同様の意味は伝わると思います。

逆にFileInfoの中から何らかのkeyに一致するものを取得する場合、単にSearchFrom(FileInfo, key)となるでしょう。取得するデータの種別に名前がついていたり、区別する必要があるのであれば、ここもSearchXXXFromでXXXに適切な名前を入れても良いでしょう。（AttributeとかPropertyとか）

Fromは無くても伝わるかもしれませんが、ここではメソッドがコレクションクラスに属していない前提のため、あった方が明示的に「ここから」という意味を伝えられると思います。

追記

上記回答で一点漏れてましたが

複数のFileInfoを検索するというよりは、FileInfoのリストを検索するというニュアンスになる気がします。

この言い回しが微妙に分かりづらいのですが、これが取得する対象の単複の区別の話だとすると、それは基本的にメソッドの戻り値で判別可能で、あまり神経質にならなくてもわかるハズです。利用者は、メソッドの名前だけでなくシグネチャ全体で判断できます。

戻り値が単一のFileInfoなら１件のFileInfoを取得するメソッドであるのは明らかだし、FileInfoの配列やコレクションであれば複数件を取得するものだとわかります。

命名で差をつけるとすれば前者がFind(条件), FindOne(条件)、後者がFindAll(), FindBy(条件)みたいな形が分かりやすいとは思いますが。

いずれにせよ、迷った場合は利用している環境のフレームワークや標準ライブラリの命名に寄せるのが一番伝わりやすいため、ここで挙げたものが全てではないですが。

Answer 2

FileInfoでは抽象的なので、FileMetaDatum（複数形がFileMetaData）のようにしてはどうでしょうか?

Comments

[gentaro]

単語の起源やアカデミックな意味での厳密性を気にするのであればdataとdatumを使い分けるのはアリかも知れませんが、正直単数でもdataを使うのは英語圏でも一般化していますし、とりわけ我々日本人の立場では「データ」「データム」の使い分けなんてもっと意識しないので、datumを使うぐらいなら別の語で置き換える方が良いように感じます。
https://www.sanctio.net/data/
他に適切な言い換えができない場合はやむを得ないと思いますが。

Answer 3

「FileInfoを検索し複数のFileInfoを返す」という指定自体があいまいです。

検索する対象は「FileInfoのXXXX」(リストとか)になるはずで、それが命名に影響するでしょう。

また、「検索結果が複数のFileInfoである」ことを、動詞Searchでは表現しきれていないと考えます。
「(条件に合う)最初の1個を検索する」ときでもSearchが使えそうですよね。
FindAllナントカとか、そういう命名のほうがよいのでは。