クックブック : イケてるオブジェクト命名規則

2001/11 Run

Zopeでサイトを開発している最中にお世話になる管理画面。オブジェクトが階層型ファイルシステムみたいに表示されて色々と便利なんだけども、1つのフォルダに格納するオブジェクトが増えてくるとなにがなんだか分からなくなる事多し。

一応アイコンが表示されるので、オブジェクトの種別は分かるんだけども、フォルダやらドキュメントやらメソッドやらが入り乱れて、醜いことこの上ない。

以下のルールでオブジェクトを命名すると、オブジェクト一覧が超見やすくなるですよ。URLもかっちょよくなるのでお勧め。

• フォルダオブジェクトの先頭の文字は必ず大文字にする。他の種類のオブジェクトは小文字で始める。このルールを守るだけでフォルダオブジェクトが一覧画面の上の方に集まって表示されるです。
• 出来るだけ略語は使わない。ユーザはURL文字列で自分が何処にいるのかを確認することが多い。また開発中もどのオブジェクトがなにをしているのかを把握しやすいからね。キータイプ量は多くなるけど我慢我慢。メンテナンス時に楽できると思えばこんな労力屁でもないでしょ。
• 複数単語で名前を構成する場合、単語間の区切りにアンダーバーは使わない。管理画面で見るとリンクを示す下線と重なっちゃってスペースなんだかアンダーバーがあるのかわからんから。あとURLにアンダーバーが出てくるのはダサい。
• 何かを表示するオブジェクトで、URLに直接現れると思われるものには show とか display とかいう接頭辞を付ける。たとえば showAllEmployee みたいに。これでURLを見ただけでどんなデータを見ているのかがユーザにも分かる。

等々。接頭辞を旨く使うと、動作が似ているものが管理画面上でも同じような位置に表示されるので、マウスカーソルが画面上を泳ぎまくることも少なくなるし、統一された命名規則を使っていると、オブジェクト名を覚えておく負担も減少して、「あのオブジェクト、なんて名前だったかなぁ」と管理画面を彷徨う事も減るはずです。

非常に簡単なことだけれども、自分流の命名規則を作るとサイト構築の効率が非常にUPするので、是非お試しあれ。

コメント

Last edited Mon, 11 Sep 2006 03:46:17 +0900

Edit this page