プログラミングにおける略称のベストプラクティス(を誰か教えてください)
XML, DOM, JSON, APIなどの略称を変数の命名等で使う時のフォーマット統一したい(して欲しい)。
XMLHttpRequest
XML
、
Extensible Markup Language(エクステンシブル マークアップ ランゲージ)
ウィキペディア: Extensible Markup Language
Http
、
Hypertext Transfer Protocol(ハイパーテキスト・トランスファー・プロトコル、略称 HTTP)
ウィキペディア: Hypertext Transfer Protocol
Request
。
XML
だけ全部大文字、(略称)(略称)(単語)の組み合わせ。
DOMContentLoaded
そもそもイベントタイプって全部小文字やなかったんかいというツッコミを入れつつ。
DOM
、
Content
、Loaded
。
はいはいなるほど、頭文字の略称だけは全て大文字にするっていうパターンね、だんだん見えてきたよ。
組み合わせは(略称)(単語)(単語)。
jsonFlickerApi
flickrのAPIをJSONPで使うときに呼び出される関数の名前
なんと固定。
任意の名前を指定できない。
これは、メソッド名だから頭文字の略称はすべて小文字にするのか、ふむふむ。
Api
は略称だけど普通にキャメルケース。
toJSON
と思ったらそうでもないんだねえぇ〜、JSON
は全部大文字なんだねえぇ〜。
こんな感じなので自分で命名する時も迷う。
ちゃんとした命名規則欲しい。
snake_case
だといいなと思ったけど、そういう問題じゃないっぽい。
railsにはActionModel::Serializers::Xml
というモジュールと、ActiveSupport::XmlMini_Nokogiri::Nokogiri::XML
というモジュールが存在する(Dashで見ただけですが)。
何か法則があるのかも知れないけど分からない。
個人的に略称は大文字か小文字どちらかに統一したいという欲求はある。 クラス、定数なら大文字、インスタンス、変数やメソッドなら小文字で全部書きたい。
結局どうするのがいいんでしょうね
みたいに書くのが一番規則性が保たれるような気がしている今日このごろ。