多能工生産技術者の日常

20歳からFXの自動売買を開発しています。24歳からは株式投資等で純資産1000万円を目指します。


スポンサードリンク

【プログラミング】~命名規則について~

スポンサーリンク

KeyKです。
今までプログラムを作成してきましたが、基本的には自分が読めればよくて、あまり命名規則を気にしたことがありませんでした。
会社に入ってから、他人にプログラムを見られる機会が増えたので、命名規則について軽く書きたいと思います。

記法について

プログラミングを学んだことのある人からすると、「見たことある!」という記法について説明します。

  • キャメル記法

2つの単語を繋げる際、2つ目の単語の頭文字を大文字にする記法です。

userSelect
  • スネーク記法

2つの単語を繋げる際、1つ目と2つ目の単語をアンダーバーで繋いだ変数で表す記法です。

user_select

自分でプログラムを書くとき、とりあえず宣言する変数では「test」や「num」などを使うことが多いです。また、それらの変数の後に数字をくっつけていくつか使うこともあります。
良くないですね~~。。

murashun.jp

命名規則を気にする理由

それこそ、プログラムがブラックボックスで動作さえしていればいい程度であれば、命名規則を気にする必要はありません。しかし、会社やグループでプログラムを共有する際には、他人にも読みやすいプログラムを書くことが重要です、
そのためにも、是非命名規則について習得しておきたいですね!

コメント文を残すことも大事

プログラムを見返していると、どのような動きをしているのか全く分からないことが往々にしてあります。特に、めちゃくちゃ読みにくいと思うプログラムは自分のものが多いです。笑
コメント文で引数や動作、戻り値を少しでもメモしておくことで、自分が書いたプログラムも多少は読みやすくなるのではないでしょうか。

f:id:KeyK:20191202205058p:plain

   

プライバシーポリシー お問い合わせ