プログラミングで名前を簡単に付けるコツ
名前を付けるのに時間がかかっている方へ。
プログラムを書いているとクラス名、変数名、関数名と
名前を付ける機会は何度もあります。
にもかかわらず、ひとつの名前を付けるだけでも時間がかかってしまうので、
すべて名前を付ける頃には、かなりの時間を使うなんてことに。
さらに、英語が苦手な方・英語に馴染みのない方にとっては
名前を付けるための英単語を考えるときも止まってしまいがちです。
結果、一つ名前を付けるだけで疲れてしまい、
肝心のコーディングをするときには集中力がプッツリ切れているなんてことも。
本記事では名前を付けることが苦手な方・プログラム初心者の方向けに
自分が使っている名前を付ける方法を提案したいと思います。
参考になればうれしいです。
サクサク命名してコーディングを進めましょう！
目次
英語考える前にまず日本語の名前をパターンで付ける
名前を付けるパターンは大きく３つあると考えています。
ひとつずつ見ていきましょう。
クラス名、プロパティ名、変数名は名詞にする
クラス名、プロパティ名、変数名は、もの・ことを指し示す機会が多いので
名詞をつけていきます。
「商品」や「商品名」とかです。
特徴を付けて「人気の商品」など名詞で終わる名前でもOKです。
関数名、メソッド名は動詞にする
「～する」で終わる動詞がよいです。
- ◇◇する
- 〇〇を◇◇する
- 〇〇を▲▲に◇◇する
「注文する」とか「商品を注文する」ですね。
関数やメソッドは機能/処理を担当しているので動詞で名前を付けてあげます。
短い文章なので名前とかかぶることもあります。
しかし、コーディングしている言語にもよりますが
名前がかぶりOKの言語もあるので調べてみてください。
この仕様のことをオーバーロードといいます。
bool型は例外で「~かどうか」で名前をつける
bool型は特殊です。True or FalseつまりはYesかNoを表しています。
それゆえ、変数名であっても関数名であってもbool型は「どちらか」を
指す言葉なので質問っぽい感じになります。
boolを使用する場合はプロパティ・変数・関数・メソッドにかかわらず、
- 〇〇かどうか
- 〇〇されたか
とYesかNoでこたえられるような日本語を用意しましょう。
実際にbool型がやっていることもYesかNoを判断していますし、
bool型はif文といっしょに使われたときにまるで英文のようになります。
記事が「発行されたかどうか」の例です。
if(article.isPubulished())
{
//～
}
else
{
//,,,
}if article is publised ~ else ,,, .
bool型に〇〇flagを使わないでください規約を見たことがありますが、
これが理由かもしれませんね。
プログラミング特化の翻訳サービスを使おう
codicというプログラミング特化の翻訳サービスを使います。無料です。
さっそく作った日本語を入れてみましょう。
例として「発行されたかどうか」を入力すると「is_issued」となります。
複数の単語があるときは「_」で区切られています。
そのまま使っても良いですし、お使いの言語に合わせて「isIssued」に
変えたりしてください。
最後に辞書で精度を上げよう
翻訳が出来たら次は辞書で確認していきます。
使い慣れたWeb辞書で良いと思いますが
今回はweblioというサービスを使います。
なぜ辞書を使うかといいますと、
翻訳サービスは文脈から「これだ」という単語を選び出しますが、
プログラミングの名前をつけるのに使う文章や単語は短いので、
どうしても制度が落ちてしまうのです。
例えば「発行されたか」で使用される「発行」もしくは「発行する」
という単語を検索してみると候補はたくさんでてきます。
今回は「発行」です。
- publish
- issue
- bring out
- put into
- float
weblioでは候補と一緒に使用例が書かれているのでそれを参考に選択します。
- 新聞・雑誌
- 証明書・貨幣
- 紙幣[切手, 株券]
- ビザ
「発行されたかどうか」を使う対象が「証明書」ならissueなので
「is_issued」をそのまま使いましょう。
もし「記事」ならば該当はありませんので近い日本語を選びます。
新聞・雑誌が近そうであればpublishを選んで「is_published」にしましょう。
まとめ
これで名前付けは終了です。
いかがでしょうか。
日本語の用意、翻訳サービス、辞書サービスの
３ステップで、とんちんかんな名前になる可能性はかなり減りますし、
やることを明確にすれば名前を付ける時間は短くなると思います。
慣れてくると日本語の用意から翻訳サービスまでの
変換パターンが見えてきます。
そうなれば、日本語の用意から翻訳サービスは省略して
辞書サービスから始めてもよいです。
