【プログラミング】メソッド名や関数名などを英語で命名する際に参考にしているQiitaの記事5選

インターネット・パソコン
スポンサーリンク

エンジニアとしてプログラミングをする際、悩む問題の一つとしてメソッド名や関数名、クラス名などの命名規則があります。

僕はあまり英語が得意でなく、文法的に問題ないか?ネイティブが使うような感覚で英語での命名が出来ているか?がいまいち自信を持てずにいます。

良いコードの性質の一つに、コードを読めば意図を理解でき、よほどのことがない限りコメントが不要というものがあると考えています。

上記を満たすためには、適切なクラス設計と英語での命名規則が重要となります。

…英語に自信がないと困りますね。

そんな僕がQiitaで見つけ、実際に参考にしている記事を5つご紹介します。

モデルやメソッドに名前を付けるときは英語の品詞に気をつけよう

「プロを目指す人のためのRuby入門」の著者でもある伊藤淳一さんの記事です。

モデルやメソッドごとで命名規則を説明していたり、ケースバイケースで詳細に英語の使い分けが記述されておりとても参考になる記事です。

エンジニアなら読んでおきたい記事の一つになりそうですね。

余談ですが、この方にはRSpecの書き方などかなりお世話になっており圧倒的感謝です。

モデルやメソッドに名前を付けるときは英語の品詞に気をつけよう - Qiita
はじめに 他の人が書いたコードを読んでいるときに時々気になるのが、英語の間違いです。 特に動詞、名詞、形容詞の使い分けが間違っていたりすると、かなり違和感を感じます。 そこで今回はモデルやメソッドに名前を付けるときの基本的な原...

プログラミングでよく使う英単語のまとめ【随時更新】

こちらに記載されている英単語でかなりのメソッドやモデル名の単語を網羅できるのではないでしょうか?

また、以下のようなシリーズごとにまとめられており、大変便利ですね。

  • 使ってはいけない言葉
  • 使わないほうがよい言葉
  • 対になる言葉
  • 似た意味の言葉 / ニュアンスの違い
  • 間違いやすい言葉
  • 間違いやすい読み方
  • 頻出単語
  • 関係のある言葉

略語なども多くまとめられているので、初心者にありがちな大体略される英単語を長々と書いてしまう問題の対策にもなります。

プログラミングでよく使う英単語のまとめ【随時更新】 - Qiita
プログラミングでよく使う英単語のまとめ【随時更新】 随時追加、整理していきます。 名前をつけるときには、名詞、動詞の違い、複数形、過去形などに注意しましょう。 オブジェクト指向では、クラス名は名詞、メソッドは動詞とします。 ...

うまくメソッド名を付けるための参考情報

こちらはメソッドに特化した記事となります。

プログラミングといえばメソッドのコレクションのようなイメージがあるので、本当によく参考にさせて貰ってます。

メソッドは原則、一つのことのみを行うことを念頭にコーディングしていくと「あれ?これどういう名前にしよう?」という状況がまあまああります。

そんな時、この記事を参考に「この動詞が合うかも?」と見つけ出すことができます。

うまくメソッド名を付けるための参考情報 - Qiita
クラス名編をつくりました あるメソッドを定義しようとするとき、そのメソッドを使う人達が名前からどんなことをするか理解できるようにするには、メソッドの内容に応じて適切な情報量の命名が求められます。 この記事では、メソッド名に用いるこ...

GitHubで使われている実用英語コメント集

こちらの記事はメソッド名などとは違い、gitのコミットメッセージでの頻出動詞と単語をGithubの人気のリポジトリから抽出したものとなります。

モダンな開発環境では基本的にgitでバージョン管理をするのが主流だと思います。

一つの作業粒度でコミットする際に英語でどういった変更を加えたのが正しく表記しないと「git log」などでコミットを一覧で確認する時に「これは何を変更したコミットなの?」が正しく理解出来ず、結局コミットの変更差分を見て理解するという手間が発生してしまいます。

英語で正しく表記し、gitのコミットを一目でどういった変更があったか確認できるようにしましょう。

GitHubで使われている実用英語コメント集 - Qiita
この記事はリクルートライフスタイル Advent Calendar 2015 - Qiita の17日目です。 こんにちは。現在、ホットペッパーグルメのエンジニアをやっている敷地@shikicheeです。 gitで英語のコミット...

ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ

こちらの記事もgitのコミットメッセージに関するものですね。

筆者の方はシリコンバレーで英語ネイティブの方と実際に働いて同僚が行ったコミットのメッセージから頻出しているものを紹介してくれています。

かなり実用的です。

ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ - Qiita
あいさつ 英語ネイティブのエンジニアと働き始め4ヶ月ほど経ちますが (参考: シリコンバレーで仕事得るのクッソ楽勝だったわ〜) 今でもたまに $ git commit -m ' ウッ ここで詰まる事は往々にしてあります...

最後に

以上で、メソッド名や関数名などを英語で命名する際に参考にしているQiitaの記事の紹介を終わります。

本当に参考にしていたので有用だと思います。

最近はコードを書く作業から少し離れていますが、また時間を見つけて自分の作りたいサービスを気の赴くままに開発するという最高の贅沢をしたいですね。

疎結合に、可読性、保守性の高い綺麗なコードがかけると楽しいものです。

英語が苦手な方、ぜひこの記事を参考に命名の楽しさを広げていただけたらと思います。

タイトルとURLをコピーしました