”命名” って大事だよ！

”命名規則” を決めよう！

テッド (cleantted)

VRCLT #7

自己紹介

・登壇者：�　cleantted (テッド)�　紫色のニコ or ミーシェちゃんアバター��・趣味：�　音ゲー (DDR etc.)�　競技プログラミング��・過去の登壇：�　#2: 競技プログラミング�　#5: VRC_Panorama×IFTTT�　#6: DDRのﾊﾟｧｰﾉｩ光らせてみた

​

Twitter: @cleantted_s, Discord: 妹尾/テッド#3519

突然ですが、問題です

Q1. 何のファイルでしょう？

​

​

Q2. 一番最新のファイルはどれでしょう？

サークルメンバーから、以下のfbxファイルが送られてきました

突然ですが、問題です

サークルメンバーから、以下のfbxファイルが送られてきました

Q1. 何のファイルでしょう？

→ Vketに使用するブースのモデルデータ

​

Q2. 一番最新のファイルはどれでしょう？�→ 「huryuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu.fbx」

そうだ、今度のLTは�“命名” について�話をしよう……（実話）

今回話す内容

• “命名” って大事だよ
• 「名前を付けるルール」を決めよう
• 名前は意味のあるわかりやすいものにしよう

今回話さない事：

• キャラクター、ワールド、イベントの名前のつけ方
• 人の目を引く名前のつけ方

​

“命名” とは

• モノに対して名前をつける事
• 今回扱う “命名”�プログラミング：変数名、関数名、クラス名、モジュール名、etc..�UnityやBlender ：ファイル名、オブジェクト名、etc…�
• 今回扱わない ”命名”：�キャラクター名、イベント名、ワールド名…キャッチ―さがいるもの

今回のLTで言いたいこと

• わかりやすい名前をつけよう！

​

• わかりやすい ＝「他の人が短い時間で、それが何かを理解できること」�「他の人」には、数か月後の未来の自分も含まれる

つまり、わかりやすい名前にしておくことは、自分にとってもメリットになる！

わかりにくい名前だとどうなるの？

• 作業効率が低下する
• 「名前をつけたもの」が何かを理解する時間を短縮できる
• わかりにくいと、調べる/覚えておくために時間を使う�
• 管理することが難しくなる
• 名前から何かがわからないので、整理もしにくい
• 「もういいか……」となると無法地帯化がすすむ�
• 作ったものが使われなくなる
• 再利用するためにコストがかかる
• わかりにくいものはヘイトたまりがち

​

どうすればいい？

• 名前のつけ方や表記の「ルール」を決める
• 例: 表記の仕方を統一する

​

​

• 例: 日本語やローマ字表記は使わない
• 日本語は環境・ソフトによってはバグるため
• ローマ字は単純に読みにくい
• 例外：日本語の方が分かりやすい場合もある（例：表情用のAnimation）

どうすればいい？

• 名前は意味のあるわかりやすいものにする
• 明確で具体的な単語を使う

​

​

• 誤解されにくいものにする

​

・Pipeを消す

・Pipeを透明にする

今回参考にした本

• 『リーダブルコード』（O'Reilly Japan）
• ソフトウェアエンジニア向けの本
• 命名については2, 3章に書かれている
• ソフトウェアエンジニアはみんな読もうね！！！

注意点

• これまで上げたのはあくまで一例、これでないとダメという事ではない
• 「正しい事」よりも、一貫性があることの方が大事
• すでに個人・チームにスタイルがあるなら、無理に変える必要はない
• なんとなくやっていることがあれば、それを明確にしてみる
• 複数のやり方が混ざっている場合は、どちらかに合わせる
• もし決めていない部分があれば決めておく

​

まとめ

​

• “命名” って大事だよ
• 「名前を付けるルール」を決めよう
• 名前は意味のあるわかりやすいものにしよう