Naming Rule

Jump to bottom Edit New page

0xBADDCAFE edited this page Jul 14, 2013 · 4 revisions

モジュール名

モジュール名は大文字で始まる CamelCase を用いる。階層を . で区切ることができる。

Data.String
Web.HTTP

ファイル名

ファイル名はモジュール名と同じものを使う。モジュールの階層構造とディレクトリが一致するようにする。

autoload/vital/__latest__/Data/String.vim
autoload/vital/__latest__/Web/HTTP.vim

関数名

関数名には snake_case を使用する。

Data.String.common_head

こうすることでモジュール名と関数名の違いが明確になる。

また、private な関数は _ で始める。これは習慣ではなく vital の仕様である。つまり、_ で始めることでその関数は private になる。