日時・件数・一覧の名前で、意味と単位を伝える

日付と、ある瞬間の日時を分ける

誕生日や請求の締め日は、通常は暦上の日付として扱います。一方、ログインした瞬間には時刻も関係します。birthDateとlastLoginAtのように書き分けると意図を表せますが、AtやDateを付けただけで型やタイムゾーンが保証されるわけではありません。

日時を文字列でやり取りするなら、書式も取り決めます。RFC 3339では日時とUTCオフセットの表現が定義されています。たとえば2026-09-22T09:00:00+09:00はオフセットを含みます。変数名とは別に、APIの仕様や型で値の形式を共有することが必要です。

数値の単位を名前に残す

timeoutが3000だったとき、3秒なのか3000秒なのかは数値だけでは判断できません。timeoutMsやtimeoutSecondsのように、名前で単位を示すと受け渡し時の確認がしやすくなります。金額も、円なのか別の通貨なのか、最小単位を整数で持つのかを決めます。

すべてを長い名前にする必要はありません。同じ単位しか登場しない狭い範囲では簡潔な名前でも読めますが、APIの引数や保存項目など、別の場所から利用される境界では単位を明示する価値があります。

// ミリ秒から秒へ変換する位置が読み取れる例
const timeoutMs = 3000;
const timeoutSeconds = timeoutMs / 1000;

一件・一覧・件数を区別する

注文一件ならorder、複数の注文ならorders、件数ならorderCountというように役割を分けます。orderDataだけでは、注文の配列なのか集計結果なのかがわかりません。型と名前を合わせて判断できる状態を目指します。

ページ分割された一覧では、いま表示している件数と、検索結果の総件数が異なります。orders.lengthをそのまま総件数として扱わないよう、totalOrderCountやvisibleOrderCountのように範囲も区別します。

ツールへ渡す前に、対象と範囲を書き足す

CodePartnerで名前を考えるときは、「件数」から「検索条件に合う注文の総件数」へ、「日時」から「ユーザーの最終ログイン日時」へと入力を具体化します。候補が長くなりすぎた場合は、使う場所ですでに明らかな情報だけを省きます。

たとえばuser.lastLoginAtなら、userの中にあることから対象を判断できます。複数種類のログイン日時を同じ関数で扱うなら、userLastLoginAtのように対象を残す方が区別しやすい場合もあります。

• 日付・日時・経過時間のどれかがわかるか
• 単位とタイムゾーンを、名前以外の仕様でも確認できるか
• 一件・配列・件数を混同していないか
• 表示中の件数と総件数など、集計範囲が伝わるか

あわせて読みたいガイド