1. 命名規則について
プログラミングにおいて、命名規則は非常に重要な要素です。
-
明確な名前をつける
変数、関数、クラスなどの名前は、その目的や機能が一目でわかるように明確にすることが推奨されます。 -
短すぎず長すぎない名前
名前はできるだけ短く、しかし十分な情報が含まれるようにするのが一般的です。 -
一貫性
同じ概念には同じ名前を使用します。異なる名前を使うと混乱を招く可能性があります。 -
独自の省略形や略語は避ける
知らない人が見ても理解できる名前を使います。独自の省略形や略語は他人が理解するのに時間がかかる可能性があります。 -
ドメイン用語を活用する
ビジネスロジックやアプリケーションのドメインに関連する専門用語を使うことで、他の開発者とのコミュニケーションがスムーズになります。 -
動詞と名詞
関数名には動詞を、変数名やクラス名には名詞または名詞句を使います。例えば、CalculateAverage()、firstNameなど。 -
単数形と複数形に注意
配列やリストには複数形の名前（items、users）を、単一のインスタンスには単数形の名前（item、user）を使用します。 -
汎用的な名前に注意
汎用的な名前（例：data、info、temp など）は一見便利に見えますが、これらの名前はその変数や関数が何を意味するのか、どのように使用されるのかについてほとんど情報を提供しません。
2. rubyメソッドの命名でよく使うやつ
Bool値を返すメソッドの命名
is○○-
is_admin?: ユーザーが管理者であるかどうかを判断するメソッド -
is_active?: 何かがアクティブであるかどうかを示すメソッド。 -
can○○-
can_write?: ファイルやディレクトリに書き込みができるかどうかを判定します。 -
can_execute?: コマンドやクエリが実行可能かどうかを判定します。
-
-
should○○-
should_update?: データやUIが更新されるべきかどうかを判定します。
-
-
has○○-
has_children?: ノードや要素に子供がいるかどうかを判定します。 -
has_error?: エラーが発生したかどうかを判定します。 -
has_permission?: 何らかの権限が与えられているかどうかを判定します。
-
-
exists-
file_exists?: 指定されたパスのファイルが存在するかどうかを判定します。 -
user_exists?: 指定されたIDや名前のユーザーが存在するかどうかを判定します。
-
取得する系のメソッド
-
get: データを単純に取得する場合に使われます。 -
fetch: データベースやネットワークリソースから何らかのデータを取得する場合に使われることが多い。 -
retrieve: 特定の検索条件に基づいてデータを取得する場合に使われます。 -
find: 特定の条件に合致する要素を探して返す場合に使われる。
計算する系のメソッド名
-
calculate: 基本的な計算を行う場合によく使われます。 -
recalculate: 既に計算された何らかの値があるが、何らかの理由で再計算が必要な場面で使われます。
入出力のメソッド
ファイル入出力
read_file - ファイルからデータを読み込む操作。
write_file - ファイルにデータを書き込む操作。
load_csv - CSVファイルからデータを読み込む操作。
export_csv - データをCSVファイルにエクスポートする操作。
データベース操作
fetch_records - データベースからレコードを取得する操作。
save_record - レコードをデータベースに保存する操作。
update_record - データベース内の既存のレコードを更新する操作。
delete_record - データベースからレコードを削除する操作。
API呼び出し
fetch_from_api - APIからデータを取得する操作。
post_to_api - APIにデータを送信する操作。
update_via_api - APIを使用してデータを更新する操作。
delete_via_api - APIを介してデータを削除する操作。
ユーザー入出力
get_user_input - ユーザーからの入力を受け取る操作。
display_output - ユーザーに情報を表示する操作。
キュー、メッセージング
enqueue_message - メッセージをキューに追加する操作。
dequeue_message - キューからメッセージを取り出す操作。
publish_event - イベントを発行する操作。
subscribe_event - イベントを購読し、通知を受け取る操作。
キャッシュ
cache_data - データをキャッシュに保存する操作。
fetch_from_cache - キャッシュからデータを取得する操作。
invalidate_cache - キャッシュ内のデータを無効にする操作。