🎄teratailクリスマスプレゼントキャンペーン2024🎄』開催中!

\teratail特別グッズやAmazonギフトカード最大2,000円分が当たる!/

詳細はこちら
命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

Q&A

2回答

7332閲覧

「〜を用いて○する」というメソッドを命名するとき、どちらの命名がいいでしょうか?

退会済みユーザー

退会済みユーザー

総合スコア0

命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

0グッド

0クリップ

投稿2019/11/07 03:32

編集2019/11/07 05:42

質問の経緯

「カラムidでWHEREしたmy_tableテーブルのレコードを取得するメソッド」を作成しました。

サンプルは手慣れているPHP(FuelPHP)で書いてます。
やってることは上で説明してる通り、WHEREを使った単純なSELECTクエリを叩いて結果を返しているだけです。

php

1class MyTable { 2 public function fetchWithId($id) { 3 // $idでWHEREしたレコードを取得 4 return DB::query('select * from my_table where id = :id')->bind('id', $id)->execute(); 5 } 6}

このときのメソッド名を、
「IDを用いてレコードを取得する」という意味を込め、fetchWithIdとしました。

質問

その後レビューで**「こういう場合ではwithよりbyではないか」**
という意見をもらったため、改めてwithとbyの違いについてググってみたところ、

あるページによると、2語は以下の用法で区別されるらしいのです。

by 抽象的手段(動作・行為、方法・手法、運搬・交通・通信)
with 具体的手段(道具,物質・物体,材料)

これを見る限り、IDは物理的な概念ではないので個人的にはbyかな?と考えています。

ここで、
withとbyどちらがいいのか、はたまた全く違う命名が適切なのか教えてほしいです。よろしくおねがいします!

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

byでいいんじゃないですか?javascriptでもgetElementByIdというものがあるぐらいなので
レビューでbyを提案されたならあなたのいる環境ではbyが浸透している可能性が高いのでbyでいいと思います
ひとりで開発するなら好きな方にすれば良いし、みんなで開発するならみんなが感覚的に理解しやすい方を使えばいいです

投稿2019/11/07 05:45

hentaiman

総合スコア6426

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

今回のご質問のケースでは、with で違和感ありません。
逆に by の方が違和感あります。
by は動作をイメージし、 with は項目とか値とかいう名詞のイメージで捉えました。

私は普段Javaを扱うことが多いのでその土俵で考えると、オブジェクト指向的には、ID 自体をクラスとして表現するのが本来良いのだろうと考えています。(大抵IDはString や long で代替してしまいますのでその場合は selectWithId のような感じにせざるを得ませんが・・・)

java

1public fooDto selectWith(XxxId id) { 2 ... 3}

こうすると、メソッドシグニチャ全体の表現力で説明できた形にしやすそうです。

== 補足 ==

もし会社やプロジェクトで標準化があればそれに従うのは当然のことです。
属しているコミュニティー(組織など)での慣例があればそれに従う方が良いのは他の回答者の方が言及されている通りでしょう。
一貫性を保って同じように単語を使うことがとても大事です。

投稿2019/11/07 05:25

編集2019/11/07 06:35
ironya

総合スコア456

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.36%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問