【日本人エンジニア必携】英語命名規則の決定版

# ユーザーIDが存在するかどうか
user_id_exists

# True　→　存在する
# False　→　存在しない

# 購入履歴を表示するかどうか
show_purchase_histories

# True　→　表示する
# False　→　表示しない

# 自動音量調節機能ON/OFF
auto_volume_adjustment_enabled

# True　→　自動音量調節機能ON
# False　→　自動音量調節機能OFF

# 購入済み商品を含むか
has_purchased_items

# True　→　購入済み商品を含む
# False　→　購入済み商品を含まない

# 空かどうか
is_empty

# True　→　空である
# False　→　空ではない

# atの場合は日時
# 作成日時
created_at

# onの場合は日付
# 削除日
deleted_on

# リストなど複数のデータが集まったもの

# ユーザーIDのリスト
user_ids
# クリック履歴のリスト
clicked_histories

# 形容詞により説明を加える

# 新しいコンテンツ
new_contents

# 受動態やing形でもよい

# クリックされたコンテンツ
clicked_contents
# 待機中の処理
waiting_process

# 商品の状態
item_condition

# condition_of_itemなどとすると長くなってしまう

# 許可のないユーザー
user_without_permission

# 発送前の商品
item_before_shipping

# 発送後の商品数
item_quantity_after_shipping

# クラス内で定義されており、目的語が明白である場合などには動詞のみでよい
# メッセージを作成する
class MessageCreator:
    
    ...
    
    def create(self):
        ...
        return message
# create_messageとしない

# 目的語を明示する場合
# 文字列を結合する
def join_strings(first_text:str, second_text: str)

class User:
    def __init__(
        self,
        user_id: int,
        name: str,
        age: int,
        ):
        self.user_id = user_id
        self.name = name
        self.age = age

    # ユーザーの名前を取得
    def get_name(self):
        return self.name

# 未読のメッセージを取得
def select_unread_messages(messages: list[Message])

# データベースから商品データを取得
def fetch_items()

# 商品のリストから指定した色・値段の商品を検索
def search_items(items: list[Item], color: str, price: int)

# ファイルやディレクトリの中から、指定した名前のファイルを探す
def find_file(path, filename):
# データベースの中から、指定した条件に合致するレコードを見つける
def find_record(database, condition):

# ローカルのファイルを読み込む
def load_file(file_path: str)

# 読み込んだファイルから1行だけ取得する
def read_line(file: File, row_number: int)

# コンテンツのリストからお気に入り登録されたものを取得する
def filter_bookmarked_contents(contents: list(Content))

# 辞書のリストから指定したキーの値だけを抽出
def extract_values(dicts: list[dict], key: str)

class User:
    def __init__(
        self,
        user_id: int,
        name: str,
        age: int,
        ):
        self.user_id = user_id
        self.name = name
        self.age = age

    # Userオブジェクトから辞書に変換
    def to_dict(self):
        return {'user_id': self.user_id, 'name': self.name, 'age': self.age}

class Item:
    def __init__(
        self,
        item_id: int,
        name: str,
        number: int,
        is_purchased: bool
        ):
        self.item_id = item_id
        self.name = name
        self.number = number
        self.is_purchased = is_purchased

    # 購入済みかどうかのフラグを切り替える
    def toggle_purchase_status(self):
        self.is_purchased = not self.is_purchased

# 支払い合計金額の更新
def update_total_payment()

# 文字列の一部を修正
def modify_text(text: str, terget_str: str, new_str: str)

class User:
    def __init__(
        self,
        user_id: int,
        name: str,
        age: int,
        ):
        self.user_id = user_id
        self.name = name
        self.age = age

    # ユーザーの名前を変更
    def change_name(self, new_name: str):
        self.name = new_name

# アイテムリストの中の古いアイテムを新しいアイテムと入れ替える
def replace_old_items(items: list[Item], new_item: Item, old_item: Item)

# 状態を元の状態に戻す
def restore_state()

def correct_event_start_date(events: list[Event], correct_date: date)

class Config:
    def __init__(
        self,
        auto_volume_adjustment_enabled: bool
        ...
        ):
        self.auto_volume_adjustment_enabled = auto_volume_adjustment_enabled
        ...

    # 自動音量調節機能をONにする
    def enable_auto_volume_adjustment():
        self.auto_volume_adjustment_enabled = True

def __init__(
        self,
        auto_volume_adjustment_enabled: bool
        ...
        ):
        self.auto_volume_adjustment_enabled = auto_volume_adjustment_enabled
        ...

    # 自動音量調節機能をOFFにする
    def disable_auto_volume_adjustment():
        self.auto_volume_adjustment_enabled = False

# 検証ルールを適用する
def apply_validation()

# テーブル（データベース）に新しいレコードを追加
def add_record()    # addはデータベース以外にも、コレクションやリストなどデータ構造に追加する

# テーブル（データベース）に新しいレコードを追加
def insert_record()    # データベースにデータを挿入する

# 商品一覧の末尾にアイテムを追加する
def append_item(items: list[Item], additional_item: Item)

# 商品一覧の先頭にアイテムを追加する
def prepend_item(items: list[Item], additional_item: Item)

# 商品一覧の任意の場所にアイテムを追加する
def insert_item(items: list[Item], additional_item: Item, index: int)

# 商品リストをひとまとめにする
def merge_items(kids_items: list[Item], senior_items: list[Items])

# ランダムにパスワードを作成する
def generate_password()

# 指定したカラムを持つ空のデータフレームを作成
def create_empty_dataframe(columns: list[str])

class User:
    def __init__(
        self,
        user_id: int,
        name: str,
        age: int,
        ):
        self.user_id = user_id
        self.name = name
        self.age = age
    
    
    def delete(slef):
        del self

# 権限のないユーザーを削除する
def remove_denied_user

ブックマークリストの中身を空にする
def clear_bookmarks

# セッションを完全に破棄する
def destroy_session()
# メモリを完全に開放する
def dispose_memory()

# 限度額を超えていないかどうかを検査
def validate_price(item: Item, max_price: int)

# 認証を確認する
def verify_authentication()

# アクセスを許可する
def allow_access()

# 申請を承認する
def accept_application()

# ユーザーにテキスト編集権限を与える
def grant_user_edit_text()

# 申請を退ける
def refuse_application()    # acceptの反対として使われる。
def reject_application()    # acceptの反対として使われる。refuseよりも強い禁止。
def deny_application()    # allowの反対として使われる。

# 許可を取り消す
def revoke_permission()

class User
class Content
class Item

# 添付ファイル
class AttachedFile
# クリック履歴
class ClickHistory

# BigQueryとの通信や操作を担う
class BigQueryClient

# タイムラインに関連する操作を管理する
class TimelineGateway

# コンテンツの保存を担う
class ContentStore
class ContentStrage

# 履歴をキャッシュする
class ClickHistoryCache

# APIの利用ログを保存
class APIUsageLog

# クリック履歴を保存
class ClickHistory

# 推薦システムの設定を保存
class RecommendationConfiguration
class RecommendationPreference
class RecommendationSetting

# 条件に合わないコンテンツを除外
class ContentFilter

# 条件に合ったコンテンツを抽出
class ContentExtructor

# メッセージの整形を担う
class MessageFormatter

# Google Analyticsのイベントを収集
class GAEventCollector

# タイムラインに関連するデータを提供する
class TimelineProvider

# 設定を管理する
class ConfigurationManager

# ブックマークされたコンテンツを読み込む
class BookmarkedContentLoader

# API利用ログを出力する
class APIUsageLogger

# アプリケーションの設定を保存する
class ApplicationConfigurator

# JSONデータの構造を変更
class JSONStructureMigrator

# ファイルやデータのアップロードを行う非同期処理を管理する
class UploadJob
class UploadTask

# ファイルやデータのアップロードを行う処理を実行する
class UploadJobRunner
class UploadTaskRunnner

# ✕
user_data

# ◯
user_property
user_attribute

# ✕
if not disabled:
    ...

# ◯
if enabled:

# ✕
class Cotents
# Contentsオブジェクト
contents
# Contentsオブジェクトのリスト
contents_list # contentのリストのリスト?

# ◯
class Cotent
# Contentオブジェクト
content
# Contentオブジェクトのリスト
contents # 複数形にするだけでよい

user_list
query_string

# ✕
not_allowed

# ◯
denied

# ✕
is_allow
notify_expire

# ◯
is_allowed
notify_expiration