識別子の命名(1)

こんにちは,インターン生の鳥井保秀と申します.

この記事では読みやすいコードの書き方と題して,コードの見た目を整え可読性の高いコードを書くための手法をご紹介しています.

前回は読みやすいコメントについてご説明いたしました,しかしコメントが多すぎるとかえってコード全体の見通しが悪くなってしまうため,可能ならばコメントに頼らずともソースコードの意図が理解できるのが望ましいです.そのためにはわかりやすい変数や関数の名前が必要不可欠.そこで今回から二回に分けて読みやすい識別子の命名についてご紹介したいと思います.

ソースコード上で命名が必要な変数名,関数名,クラス名等これらはまとめて識別子と呼ばれますが,これらが読みにくいと,当然コード全体が読みにくくなってしまいます.そのためまず今回は識別子の見た目を整えることを考えます.

識別子の見た目を表す記法には主に以下のようなものがあります.

・パスカルケース(アッパーキャメルケース):すべての単語の先頭を大文字にする.クラス名に使用される.
 例:PascalCase
・キャメルケース(ロウワーキャメルケース):二番目以降の単語の先頭を大文字にする.変数名や関数名に使用されることが多い.
 例:camelCase
・コンスタントケース(アッパースネークケース):すべての単語を大文字で書き,単語間をアンダーバーでつなぐ.定数名に使用される.
 例:CONSTANT_CASE
・スネークケース(ロウワースネークケース):すべての単語を小文字で書き,単語間をアンダーバーでつなぐ.関数名や変数名に使用されることが多い.
 例:snake_case
・チェインケース(ケバブケース):単語を小文字で書き,単語間をハイフンでつなぐ.HTMLのclass名やid名に使用される.
 例:chain-case

例えば私はC++での開発時はおおよそ
変数名: スネークケースorキャメルケース
関数名: キャメルケース
定数名: コンスタントケース
クラス名: パスカルケース
名前空間名:パスカルケース
となるようにすることが多いです.

このあたりのルールは人や組織によって異なり,何が良いというわけではありませんので,組織の方針や周りの状況を見て使い分ける必要がありますが,プロジェクトの開始時に自分の中で何かしらルールを作っておいた方がコードの見栄えが良くなります.

今回は識別子の見た目を整える重要性についてご説明いたしました.見た目を整えることによりコード全体の見通しが良くなり,同じ内容のコードでもストレスなく目を通すことができるようになります.

しかしながら,見た目がきれいでも識別子の意味そのものが分かりにくければ,読みやすいコードとは呼べません.そこで次回は識別子の意味を分かりやすくするための識別子の名づけ方についてご紹介する予定です.

興味を持たれた方はお気軽にお問い合わせください。

インターンシップへの申し込み・お問い合わせ先

インターンシップへの申し込み・お問い合わせ先
メールでのお問い合わせは、下記フォームに入力して送信してください。
ご氏名 (例)山田 太郎
メールアドレス 半角英数字:ご入力間違いのないようにご注意ください
メールアドレス(確認用) 半角英数字:ご入力間違いのないようにご注意ください
電話番号 (例)0354339211 ※ハイフン抜きで入力してください
題名
お問合わせ内容

アーカイブ

カテゴリー