プログラミング命名チートシート

プログラミングをしていると、変数名や関数名、クラス名などの命名に悩むことがあります。 命名が適切でないと、コードが読みにくくなったり、他の人がコードを理解しにくくなったりします。 この記事はプログラミングの命名に関するチートシートです。

変数名、関数名、クラス名について随時更新していきます。

関数

真偽値を返す関数

命名: is + 名詞
説明: isは状態を表す場合に使う。
使用例: isExist, isActive, isEnable

命名: has + 名詞
説明: hasは所有を表す場合に使う。
使用例: hasPermission, hasError, hasValue

命名: can + 動詞
説明: canは可能性を表す場合に使う。
使用例: canEdit, canDelete, canUpdate,

命名: should + 動詞
説明: shouldは必要性や義務を表す場合に使う。
使用例: shouldUpdate, shouldRefresh

データを取得する関数

命名: get + 名詞
説明: getはデータの取得を表す場合に使う。
使用例: getUser, getProduct, getOrder

命名: fetch + 名詞
説明: fetchは外部からデータを取得することを表す場合に使う。
使用例: fetchUser, fetchProducts, fetchOrders

命名: query + 名詞
説明: queryはデータベースやAPIからデータを取得することを表す場合に使う。
使用例: queryUsers, queryProducts, queryOrders

命名: find + 名詞
説明: findは特定の条件に基づいてデータを検索することを表す場合に使う。
使用例: findUserById, findProductByName, findOrderByNumber

命名: search + 名詞
説明: searchはキーワードや条件に基づいてデータを検索することを表す場合に使う。
使用例: searchUsers, searchProducts, searchOrders

命名: lookup + 名詞
説明: lookupはキーに基づいてデータを検索することを表す場合に使う。
使用例: lookupUserById, lookupProductByCode, lookupOrderByNumber

データを設定する関数

命名: set + 名詞
説明: setはデータの設定を表す場合に使う。
使用例: setUser, setProduct, setOrder

命名: update + 名詞
説明: updateは既存のデータを更新することを表す場合に使う。
使用例: updateUser, updateProduct, updateOrder

命名: save + 名詞
説明: saveはデータを永続的に保存することを表す場合に使う。
使用例: saveUser, saveProduct, saveOrder

データを削除する関数

命名: delete + 名詞
説明: deleteはデータを完全に削除することを表す場合に使う。
使用例: deleteUser, deleteProduct, deleteOrder

命名: remove + 名詞
説明: removeはデータをコレクションや構造体から取り除くことを表す場合に使う。
使用例: removeUser, removeProduct, removeOrder,

命名: clear + 名詞
説明: clearはデータをリセットまたは初期化することを表す場合に使う。
使用例: clearUsers, clearProducts, clearOrders

データを検証する関数

命名: validate + 名詞
説明: validateはデータの整合性や妥当性を検証することを表す場合に使う。
使用例: validateUser, validateProduct, validateOrder

命名: check + 名詞
説明: checkはデータが特定の条件を満たしているかどうかを検証することを表す場合に使う。 使用例: checkUser, checkProduct, checkOrder

命名: verify + 名詞
説明: verifyはデータの正確性や真正性を検証することを表す場合に使う。
使用例: verifyUser, verifyProduct, verifyOrder

データを変換する関数

命名: convert + 名詞 + To + 名詞
説明: convertはあるデータ型から別のデータ型へ変換することを表す場合に使う。
使用例: convertUserToJson, convertProductToXml, convertOrderToCsv

命名: parse + 名詞 + To + 名詞
説明: parseは文字列などの形式化されたデータを解析し、構造化されたデータに変換することを表す場合に使う。 使用例: parseUserFromJson, parseProductFromXml, parseOrderFromCsv

命名: format + 名詞 + To + 名詞
説明: formatはデータを特定の形式や書式に変換することを表す場合に使う。
使用例: formatUserToString, formatProductToHtml, formatOrderToPdf

データを集計する関数

命名: calculate + 名詞
説明: calculateはデータに基づいて計算や演算を行うことを表す場合に使う。
使用例: calculateUserAge, calculateProductPrice, calculateOrderTotal

命名: aggregate + 名詞
説明: aggregateは複数のデータを集計して単一の値や結果を得ることを表す場合に使う。 使用例: aggregateUserStats, aggregateProductSales, aggregateOrdersByMonth

命名: summarize + 名詞
説明: summarizeはデータを要約や集約することを表す場合に使う。
使用例: summarizeUserActivity, summarizeProductPerformance, summarizeOrderTrends

イベントを発行する関数

命名: emit + 名詞
説明: emitはイベントを発生させることを表す場合に使う。
使用例: emitUserCreated, emitProductUpdated, emitOrderCancelled

命名: trigger + 名詞
説明: triggerはイベントやアクションを引き起こすことを表す場合に使う。
使用例: triggerUserLogin, triggerProductPurchase, triggerOrderShipped

命名: dispatch + 名詞
説明: dispatchはイベントやアクションを送信や割り当てることを表す場合に使う。
使用例: dispatchUserEvent, dispatchProductAction, dispatchOrderNotification

トランザクションを処理する関数

命名: begin + 名詞
説明: beginはトランザクションを開始することを表す場合に使う。
使用例: beginUserTransaction, beginOrderTransaction, beginDatabaseTransaction

命名: commit + 名詞
説明: commitはトランザクションをコミットすることを表す場合に使う。
使用例: commitUserTransaction, commitOrderTransaction, commitDatabaseTransaction

命名: rollback + 名詞
説明: rollbackはトランザクションをロールバックすることを表す場合に使う。
使用例: rollbackUserTransaction, rollbackOrderTransaction, rollbackDatabaseTransaction

ストリームを処理する関数

命名: read + 名詞
説明: readはストリームからデータを読み込むことを表す場合に使う。
使用例: readUserStream, readProductStream, readConfigStream

命名: write + 名詞
説明: writeはストリームにデータを書き込むことを表す場合に使う。
使用例: writeUserStream, writeProductStream, writeConfigStrea

命名: pipe + 名詞
説明: pipeはストリーム間でデータを渡すことを表す場合に使う。
使用例: pipeUserStream, pipeProductStream, pipeConfigStrea

外部サービスとの通信を行う関数

命名: send + 名詞
説明: sendは外部サービスにデータを送信することを表す場合に使う。
使用例: sendUserRequest, sendProductUpdate, sendOrderNotification

命名: receive + 名詞
説明: receiveは外部サービスからデータを受信することを表す場合に使う。
使用例: receiveUserResponse, receiveProductData, receiveOrderConfirmation

命名: request + 名詞
説明: requestは外部サービスにリクエストを送信することを表す場合に使う。
使用例: requestUserAuth, requestProductDetails, requestOrderStatus

バッチ処理を行う関数

命名: batch + 動詞
説明: batchは一連のデータをまとめて処理することを表す場合に使う。
使用例: batchUpdateUsers, batchProcessOrders, batchSendEmails

命名: bulk + 動詞
説明: bulkは大量のデータを一括して処理することを表す場合に使う。
使用例: bulkInsertUsers, bulkDeleteProducts, bulkExportOrders

命名: schedule + 名詞
説明: scheduleは定期的または予定された処理を実行することを表す場合に使う。
使用例: scheduleUserBackup, scheduleProductSync, scheduleOrderReport

UIコンポーネントを描画する関数

命名: render + 名詞
説明: renderはUIコンポーネントを描画することを表す場合に使う。
使用例: renderUserProfile, renderProductList, renderSettingsForm

命名: draw + 名詞
説明: drawはUIの一部を描画することを表す場合に使う。
使用例: drawUserAvatar, drawProductImage, drawChartLine

命名: paint + 名詞
説明: paintはUIの一部を描画することを表す場合に使う。
使用例: paintUserBackground, paintProductBorder, paintButtonText

ユーザー入力を処理する関数

命名: handle + 名詞 + 動詞
説明: handleはユーザーの入力やイベントを処理することを表す場合に使う。
使用例: handleUserClick, handleProductSelect, handleFormSubmit

命名: on + 名詞 + 動詞
説明: onはユーザーの入力やイベントに反応することを表す場合に使う。
使用例: onUserInput, onProductHover, onButtonPress

命名: process + 名詞 + Input
説明: processはユーザーの入力を処理することを表す場合に使う。
使用例: processUserLogin, processProductSearch, processPaymentInput

UIの状態を更新する関数

命名: update + 名詞 + State
説明: updateはUIの状態を更新することを表す場合に使う。
使用例: updateUserProfileState, updateProductListState, updateCartState

命名: refresh + 名詞 + View
説明: refreshはUIの表示を更新することを表す場合に使う。
使用例: refreshUserProfileView, refreshProductListView, refreshCartView

命名: sync + 名詞 + UI
説明: syncはデータとUIの同期を取ることを表す場合に使う。
使用例: syncUserDataWithUI, syncProductStockWithUI, syncOrderStatusWithUI

UIのナビゲーションを処理する関数

命名: navigate + To + 名詞
説明: navigateはあるビューから別のビューへ遷移することを表す場合に使う。
使用例: navigateToUserProfile, navigateToProductDetail, navigateToCheckout

命名: go + To + 名詞
説明: goはあるビューから別のビューへ遷移することを表す場合に使う。
使用例: goToUserSettings, goToProductReview, goToPaymentConfirmation

命名: redirect + To + 名詞
説明: redirectはあるビューから別のビューへリダイレクトすることを表す場合に使う。
使用例 : redirectToUserDashboard, redirectToProductCategory, redirectToErrorPage

データをソートする関数

命名: sort + 名詞 + By + 名詞
説明: sortはデータを特定の基準に基づいてソートすることを表す場合に使う。
使用例: sortUsersById, sortProductsByPrice, sortOrdersByDate

命名: order + 名詞 + By + 名詞
説明: orderはデータを特定の順序に並べ替えることを表す場合に使う。
使用例: orderUsersByName, orderProductsByPopularity, orderOrdersByStatus

命名: rank + 名詞 + By + 名詞
説明: rankはデータを特定の基準に基づいてランク付けすることを表す場合に使う。
使用例: rankUsersByScore, rankProductsBySales, rankOrdersByValue

データをフィルタリングする関数

命名: filter + 名詞 + By + 名詞
説明: filterは特定の条件に基づいてデータをフィルタリングすることを表す場合に使う。 使用例: filterUsersByAge, filterProductsByCategory, filterOrdersByStatus

命名: exclude + 名詞 + By + 名詞
説明: excludeは特定の条件に基づいてデータを除外することを表す場合に使う。
使用例: excludeUsersByRole, excludeProductsByBrand, excludeOrdersByCurrency

命名: limit + 名詞
説明: limitはデータの数や範囲を制限することを表す場合に使う。
使用例: limitUsers, limitProducts, limitOrders

データをグループ化する関数

命名: group + 名詞 + By + 名詞
説明: groupはデータを特定の基準に基づいてグループ化することを表す場合に使う。
使用例: groupUsersById, groupProductsByCategory, groupOrdersByDate

命名: categorize + 名詞 + By + 名詞
説明: categorizeはデータを特定の基準に基づいてカテゴリに分類することを表す場合に使う。 使用例: categorizeUsersById, categorizeProductsByBrand, categorizeOrdersByStatus

命名: classify + 名詞 + By + 名詞
説明: classifyはデータを特定の基準に基づいてクラス分けすることを表す場合に使う。
使用例 : classifyUsersByType, classifyProductsByUsage, classifyOrdersByShippingMethod

データを比較する関数

命名: compare + 名詞 + With + 名詞
説明: compareは2つのデータを比較することを表す場合に使う。
使用例: compareUserWithAnother, compareProductWithCompetitor, compareOrderWithPrevious

命名: match + 名詞 + With + 名詞
説明: matchはデータ間の一致を確認することを表す場合に使う。
使用例: matchUserWithCriteria, matchProductWithKeyword, matchOrderWithInvoice

命名: diff + 名詞 + With + 名詞
説明: diffはデータ間の差分を求めることを表す場合に使う。
使用例: diffUserWithPrevious, diffProductWithOld, diffOrderWithOriginal

データを加工する関数

命名: transform + 名詞
説明: transformはデータの構造や形式を変換することを表す場合に使う。
使用例: transformUserData, transformProductList, transformOrderDetails

命名: map + 名詞 + To + 名詞
説明: mapはデータを別の形式や構造にマッピングすることを表す場合に使う。
使用例: mapUserToDto, mapProductToViewModel, mapOrderToEntity

命名: reduce + 名詞
説明: reduceはデータを集約して単一の値や結果を得ることを表す場合に使う。
使用例: reduceUserStats, reduceProductQuantities, reduceOrderTotals

データをキャッシュする関数

命名: cache + 名詞
説明: cacheはデータをキャッシュに保存することを表す場合に使う。
使用例: cacheUserProfile, cacheProductDetails, cacheOrderSummary

命名: invalidate + 名詞 + Cache
説明: invalidateはキャッシュされたデータを無効化することを表す場合に使う。
使用例: invalidateUserCache, invalidateProductCache, invalidateOrderCache

命名: refresh + 名詞 + Cache
説明: refreshはキャッシュされたデータを更新することを表す場合に使う。
使用例: refreshUserCache, refreshProductCache, refreshOrderCache

データをバリデーションする関数

命名: assert + 名詞
説明: assertはデータが特定の条件を満たしていることを表明することを表す場合に使う。 使用例: assertUserExists, assertProductAvailable, assertOrderValid

命名: ensure + 名詞
説明: ensureはデータが特定の条件を満たしていることを保証することを表す場合に使う。 使用例: ensureUserAuthenticated, ensureProductInStock, ensureOrderProcessed

命名: require + 名詞
説明: requireはデータが特定の条件を満たしていることを要求することを表す場合に使う。 使用例: requireUserPermission, requireProductCategory, requireOrderStatus

データをロギングする関数

命名: log + 名詞
説明: logはデータをログに記録することを表す場合に使う。
使用例: logUserActivity, logProductChanges, logOrderEvents

命名: trace + 名詞
説明: traceはデータの流れや処理の経過を追跡することを表す場合に使う。
使用例: traceUserRequest, traceProductFlow, traceOrderProcess

命名: audit + 名詞
説明: auditはデータの変更や操作を監査することを表す場合に使う。
使用例: auditUserChanges, auditProductUpdates, auditOrderActions

クラス

設定情報を管理するクラス

クラス名: Configuration
説明: アプリケーションの設定情報を管理するクラス。設定値の取得、設定の更新、設定の保存などの機能を提供する。
例: AppConfiguration, SystemConfiguration, UserConfiguration

ログを記録するクラス

クラス名: Logger
説明: アプリケーションのログを記録するクラス。ログレベルの設定、ログメッセージの出力、ログのフォーマット設定などの機能を提供する。
例: FileLogger, ConsoleLogger, RemoteLogger

イベントを管理するクラス

クラス名: EventEmitter
説明: イベントの発行と購読を管理するクラス。イベントのリッスン、イベントの発行、イベントハンドラの登録などの機能を提供する。
例: DomainEventEmitter, MessageEventEmitter, CustomEventEmitter

例外を表現するクラス

クラス名: Exception
説明: 例外情報を表現するクラス。例外メッセージ、例外の原因、スタックトレースなどの情報を保持する。
例: ValidationException, BusinessException, SystemException

ユーティリティ関数を提供するクラス

クラス名: Utility
説明: 汎用的なユーティリティ関数を提供するクラス。文字列操作、日付処理、数値計算などの共通機能を提供する。
例: StringUtility, DateUtility, MathUtility

データアクセスを抽象化するクラス

クラス名: Repository
説明: データソースへのアクセスを抽象化するクラス。データの取得、追加、更新、削除などの操作を提供する。
例: UserRepository, ProductRepository, OrderRepository

サービスロジックを実装するクラス

クラス名: Service
説明: アプリケーションのビジネスロジックを実装するクラス。複雑な処理やトランザクション管理などを行う。
例: AuthenticationService, PaymentService, NotificationService

メッセージの送受信を行うクラス

クラス名: MessageBus
説明: メッセージの送受信を行うクラス。メッセージのパブリッシュ、サブスクライブ、ルーティングなどの機能を提供する。
例: EventMessageBus, CommandMessageBus, IntegrationMessageBus

外部APIとの通信を行うクラス

クラス名: ApiClient
説明: 外部APIとの通信を行うクラス。HTTP通信、認証、エラーハンドリングなどの機能を提供する。
例: RestApiClient, GraphQLApiClient, SoapApiClient

非同期処理を行うクラス

クラス名: AsyncProcessor
説明: 非同期処理を行うクラス。タスクの並列実行、タイムアウト処理、エラーハンドリングなどの機能を提供する。
例: AsyncTaskProcessor, AsyncJobProcessor, AsyncWorkflowProcessor

認証・認可を管理するクラス

クラス名: Authenticator
説明: ユーザーの認証と認可を管理するクラス。ログイン、ログアウト、アクセス制御などの機能を提供する。
例: JwtAuthenticator, OAuthAuthenticator, RoleBasedAuthenticator

キャッシュを管理するクラス

クラス名: Cache
説明: データのキャッシュを管理するクラス。キャッシュの取得、キャッシュの更新、キャッシュの無効化などの機能を提供する。
例: MemoryCache, RedisCache, FileCache

バリデーションを行うクラス

クラス名: Validator
説明: データの検証を行うクラス。入力値のチェック、フォーマットの検証、ビジネスルールの適用などの機能を提供する。
例: RequestValidator, EntityValidator, FormValidator

ファイル操作を行うクラス

クラス名: FileHandler
説明: ファイルの読み書きや操作を行うクラス。ファイルの読み込み、書き込み、コピー、削除などの機能を提供する。
例: CsvFileHandler, JsonFileHandler, ImageFileHandler

セキュリティ関連の処理を行うクラス

クラス名: SecurityManager
説明: セキュリティ関連の処理を行うクラス。暗号化、復号化、ハッシュ化、アクセス制御などの機能を提供する。
例: EncryptionManager, PasswordHasher, RoleBasedAccessControl

通知を送信するクラス

クラス名: Notifier
説明: 通知の送信を行うクラス。メール送信、プッシュ通知、SMSの送信などの機能を提供する。
例: EmailNotifier, PushNotifier, SmsNotifier

データの変換を行うクラス

クラス名: Converter
説明: データの変換を行うクラス。データ形式の変換、オブジェクトマッピング、シリアライズ/デシリアライズなどの機能を提供する。
例: JsonConverter, XmlConverter, CsvConverter

スケジューリングを行うクラス

クラス名: Scheduler
説明: タスクのスケジューリングを行うクラス。定期的な処理の実行、遅延実行、バッチ処理などの機能を提供する。
例: CronScheduler, DelayedJobScheduler, BatchProcessScheduler

外部サービスとの連携を行うクラス

クラス名: Integrator
説明: 外部サービスとの連携を行うクラス。外部APIの呼び出し、データの同期、イベントの処理などの機能を提供する。
例: PaymentGatewayIntegrator, SocialMediaIntegrator, ThirdPartyServiceIntegrator

ワークフローを管理するクラス

クラス名: WorkflowEngine
説明: ワークフローの管理と実行を行うクラス。ワークフローの定義、ステップの実行、状態の管理などの機能を提供する。
例: OrderWorkflowEngine, DocumentApprovalWorkflowEngine, BusinessProcessWorkflowEngine

データの検索を行うクラス

クラス名: Searcher
説明: データの検索を行うクラス。検索条件の指定、検索結果の取得、検索オプションの設定などの機能を提供する。
例: ProductSearcher, UserSearcher, DocumentSearcher

レポート生成を行うクラス

クラス名: ReportGenerator
説明: レポートの生成を行うクラス。データの集計、レポートのフォーマット設定、レポートの出力などの機能を提供する。
例: SalesReportGenerator, PerformanceReportGenerator, UsageReportGenerator

監査ログを記録するクラス

クラス名: AuditTrail
説明: 監査ログの記録を行うクラス。ユーザーアクションの追跡、変更履歴の記録、監査レポートの生成などの機能を提供する。
例: UserAuditTrail, DataModificationAuditTrail, SystemEventAuditTrail

設定情報を検証するクラス

クラス名: ConfigurationValidator
説明: 設定情報の検証を行うクラス。設定値の型チェック、必須項目の確認、設定の整合性検証などの機能を提供する。
例: AppConfigurationValidator, DatabaseConfigurationValidator, SecurityConfigurationValidator

ロギングの設定を管理するクラス

クラス名: LoggingConfigurator
説明: ロギングの設定を管理するクラス。ログレベルの設定、ログ出力先の指定、ログフォーマットの定義などの機能を提供する。
例: ConsoleLoggingConfigurator, FileLoggingConfigurator, RemoteLoggingConfigurator

パフォーマンスを計測するクラス

クラス名: PerformanceMonitor
説明: アプリケーションのパフォーマンスを計測するクラス。処理時間の測定、リソース使用状況の監視、ボトルネックの特定などの機能を提供する。
例: RequestPerformanceMonitor, DatabaseQueryPerformanceMonitor, MemoryUsagePerformanceMonitor

ヘルスチェックを行うクラス

クラス名: HealthChecker
説明: システムのヘルスチェックを行うクラス。サービスの可用性確認、依存関係の状態確認、リソースの監視などの機能を提供する。
例: DatabaseHealthChecker, ExternalServiceHealthChecker, CacheHealthChecker

バックグラウンドジョブを管理するクラス

クラス名: BackgroundJobManager
説明: バックグラウンドジョブの管理を行うクラス。ジョブのキューイング、ジョブの実行、ジョブの状態管理などの機能を提供する。
例: EmailSendingJobManager, DataProcessingJobManager, FileCleanupJobManager

データの移行を行うクラス

クラス名: DataMigrator
説明: データの移行を行うクラス。データのエクスポート、インポート、変換、クレンジングなどの機能を提供する。
例: DatabaseMigrator, CsvDataMigrator, LegacySystemDataMigrator

ロールと権限を管理するクラス

クラス名: RolePermissionManager
説明: ユーザーのロールと権限を管理するクラス。ロールの定義、権限の割り当て、アクセス制御の適用などの機能を提供する。
例: UserRolePermissionManager, AdminRolePermissionManager, GuestRolePermissionManager

イベントソーシングを行うクラス

クラス名: EventStore
説明: イベントソーシングを行うクラス。ドメインイベントの保存、イベントの再生、スナップショットの作成などの機能を提供する。
例: UserEventStore, OrderEventStore, InventoryEventStore

CQRS（コマンドクエリ責務分離）を実装するクラス

クラス名: CommandHandler
説明: CQRSにおけるコマンドハンドラを実装するクラス。コマンドを受け取り、対応するアクションを実行する。
例: CreateUserCommandHandler, UpdateProductCommandHandler, PlaceOrderCommandHandler

クラス名: QueryHandler
説明: CQRSにおけるクエリハンドラを実装するクラス。クエリを受け取り、要求されたデータを返す。
例: GetUserByIdQueryHandler, GetProductsQueryHandler, GetOrderHistoryQueryHandler

ドメインイベントを発行するクラス

クラス名: DomainEventPublisher
説明: ドメインイベントを発行するクラス。イベントの発行、リスナへの通知、イベントの永続化などの機能を提供する。
例: UserRegisteredEventPublisher, ProductUpdatedEventPublisher, OrderPlacedEventPublisher

集約ルートを表現するクラス

クラス名: AggregateRoot
説明: ドメイン駆動設計における集約ルートを表現するクラス。エンティティの整合性を保証し、ドメインイベントを発行する。
例: UserAggregateRoot, ProductAggregateRoot, OrderAggregateRoot

リポジトリを実装するクラス

クラス名: Repository
説明: リポジトリパターンを実装するクラス。集約ルートの永続化とロードを担当する。
例: UserRepository, ProductRepository, OrderRepository

ファクトリを実装するクラス

クラス名: Factory
説明: ファクトリパターンを実装するクラス。オブジェクトの生成を担当し、生成ロジックを隠蔽する。
例: UserFactory, ProductFactory, OrderFactory

ビルダーを実装するクラス

クラス名: Builder
説明: ビルダーパターンを実装するクラス。複雑なオブジェクトの生成を段階的に行う。
例: UserBuilder, ProductBuilder, OrderBuilder

ストラテジを実装するクラス

クラス名: Strategy
説明: ストラテジパターンを実装するクラス。アルゴリズムやロジックをカプセル化し、動的に切り替えられるようにする。
例: PaymentStrategy, ShippingStrategy, DiscountStrategy

非同期タスクを実行するクラス

クラス名: AsyncTask
説明: 非同期タスクを実行するクラス。タスクの実行、結果の取得、エラーハンドリングなどの機能を提供する。
例: ImageProcessingTask, DataExportTask, NotificationSendingTask

データの検証ルールを定義するクラス

クラス名: ValidationRule
説明: データの検証ルールを定義するクラス。検証ロジックをカプセル化し、再利用可能にする。
例: RequiredFieldValidationRule, EmailFormatValidationRule, PasswordComplexityValidationRule

Enum

UIにてデータの読み込み状況を表すEnum

命名: LoadingState
要素:

• LoadingState.loading (読み込み中)
• LoadingState.loaded (読み込み完了)
• LoadingState.error (エラー)
• LoadingState.not_loaded (読み込み前)

データの状態を表すEnum

命名: DataState
要素:

• DataState.initial (初期状態)
• DataState.modified (変更済み)
• DataState.saved (保存済み)
• DataState.deleted (削除済み)

リクエストの結果を表すEnum

命名: RequestResult
要素:

• RequestResult.success (成功)
• RequestResult.failure (失敗)
• RequestResult.pending (処理中)
• RequestResult.cancelled (キャンセル)

認証状態を表すEnum

命名: AuthState
要素:

• AuthState.authenticated (認証済み)
• AuthState.unauthenticated (未認証)
• AuthState.authenticationFailed (認証失敗)
• AuthState.authenticationExpired (認証期限切れ)

同期状態を表すEnum

命名: SyncState
要素:

• SyncState.syncing (同期中)
• SyncState.synced (同期完了)
• SyncState.syncFailed (同期失敗)
• SyncState.notSynced (未同期)

コンテンツの表示状態を表すEnum

命名: VisibilityState
要素:

• VisibilityState.visible (表示中)
• VisibilityState.hidden (非表示)
• VisibilityState.collapsed (折りたたみ)
• VisibilityState.expanded (展開)

アニメーションの状態を表すEnum

命名: AnimationState
要素:

• AnimationState.idle (アニメーション停止中)
• AnimationState.running (アニメーション実行中)
• AnimationState.completed (アニメーション完了)
• AnimationState.paused (アニメーション一時停止中)

タスクの進行状況を表すEnum

命名: TaskProgress
要素:

• TaskProgress.notStarted (未着手)
• TaskProgress.inProgress (進行中)
• TaskProgress.completed (完了)
• TaskProgress.blocked (ブロック中)

ネットワーク接続状態を表すEnum

命名: ConnectionState
要素:

• ConnectionState.connected (接続中)
• ConnectionState.disconnected (切断)
• ConnectionState.connecting (接続中)
• ConnectionState.connectionFailed (接続失敗)

バリデーションの結果を表すEnum

命名: ValidationResult
要素:

• ValidationResult.valid (妥当)
• ValidationResult.invalid (不正)
• ValidationResult.validationFailed (バリデーション失敗)
• ValidationResult.pending (検証中)

UIにてデータの読み込み状況を表すEnum

命名: LoadingState
要素:

• LoadingState.loading (読み込み中)
• LoadingState.loaded (読み込み完了)
• LoadingState.error (エラー)
• LoadingState.not_loaded (読み込み前)

データの状態を表すEnum

命名: DataState
要素:

• DataState.initial (初期状態)
• DataState.modified (変更済み)
• DataState.saved (保存済み)
• DataState.deleted (削除済み)

リクエストの結果を表すEnum

命名: RequestResult
要素:

• RequestResult.success (成功)
• RequestResult.failure (失敗)
• RequestResult.pending (処理中)
• RequestResult.cancelled (キャンセル)

認証状態を表すEnum

命名: AuthState
要素:

• AuthState.authenticated (認証済み)
• AuthState.unauthenticated (未認証)
• AuthState.authenticationFailed (認証失敗)
• AuthState.authenticationExpired (認証期限切れ)

同期状態を表すEnum

命名: SyncState
要素:

• SyncState.syncing (同期中)
• SyncState.synced (同期完了)
• SyncState.syncFailed (同期失敗)
• SyncState.notSynced (未同期)

コンテンツの表示状態を表すEnum

命名: VisibilityState
要素:

• VisibilityState.visible (表示中)
• VisibilityState.hidden (非表示)
• VisibilityState.collapsed (折りたたみ)
• VisibilityState.expanded (展開)

アニメーションの状態を表すEnum

命名: AnimationState
要素:

• AnimationState.idle (アニメーション停止中)
• AnimationState.running (アニメーション実行中)
• AnimationState.completed (アニメーション完了)
• AnimationState.paused (アニメーション一時停止中)

タスクの進行状況を表すEnum

命名: TaskProgress
要素:

• TaskProgress.notStarted (未着手)
• TaskProgress.inProgress (進行中)
• TaskProgress.completed (完了)
• TaskProgress.blocked (ブロック中)

ネットワーク接続状態を表すEnum

命名: ConnectionState
要素:

• ConnectionState.connected (接続中)
• ConnectionState.disconnected (切断)
• ConnectionState.connecting (接続中)
• ConnectionState.connectionFailed (接続失敗)

バリデーションの結果を表すEnum

命名: ValidationResult
要素:

• ValidationResult.valid (妥当)
• ValidationResult.invalid (不正)
• ValidationResult.validationFailed (バリデーション失敗)
• ValidationResult.pending (検証中)

キャッシュの戦略を表すEnum

命名: CacheStrategy
要素:

• CacheStrategy.noCache (キャッシュなし)
• CacheStrategy.remoteFirst (リモートを優先)
• CacheStrategy.localFirst (ローカルを優先)
• CacheStrategy.localOnly (ローカルのみ)

HTTPステータスコードを表すEnum

命名: HttpStatusCode
要素:

• HttpStatusCode.ok (200)
• HttpStatusCode.created (201)
• HttpStatusCode.badRequest (400)
• HttpStatusCode.unauthorized (401)
• HttpStatusCode.forbidden (403)
• HttpStatusCode.notFound (404)
• HttpStatusCode.internalServerError (500)

比較演算子を表すEnum

命名: ComparisonOperator
要素:

• ComparisonOperator.equal (等しい)
• ComparisonOperator.notEqual (等しくない)
• ComparisonOperator.greaterThan (より大きい)
• ComparisonOperator.lessThan (より小さい)
• ComparisonOperator.greaterThanOrEqual (以上)
• ComparisonOperator.lessThanOrEqual (以下)