Converter 関数の命名則

  • Converter とはある型の値を別の型に変換するための関数
  • 同じ型への変換の場合もある

to ~

  • Converter 関数の関数名は to-(変換後の型、状態) の形式が多い。

C# や Java のクラスの様に、メンバーメソッドとして定義できる場合は

(ソースとなる変数).to-(変換後の型、状態)

の形になり、関数のオーバーロードができる場合は

to-(変換後の型、状態)

の形式になる。 C の様に関数のオーバーロードができない言語の場合は『なんの型、状態から』変換するのかを明記したほうが良い。

(変換前の型、状態)-to-(変換後の型、状態)

as ~

  • 読み込むデータを、ある特定の型や表現で読み出したいときに使う。
int read_int_as_bcd(char *str, int len);

-fy, -ify

  • 『~にする』、『~化する』という意味の接尾辞 -fy, -ify を使う。
    • 名詞や形容詞につけて、○○にするという動詞を作る。
名前 動作 備考
stringify 文字列にする オブジェクトデータを JSON 等の文字列に変換する時などに使われている。
uglify 難読化する ソースコードを読みにくくする。(JavaScript はソースコードがユーザーから見れる状態になるのでこういったツールを使ってユーザーからは読みにくくする。)
minify 小さくする ソースコード (主にファイルサイズ) を小さくする。
beautify 美しくする ソースコードを綺麗なレイアウトに整形してくれるプラグイン

変換を表す動詞を使う

  • 文字列データを何がしかのオブジェクトデータに変換する場合は parse を使う。
  • C# の WPF の IValueConverter インターフェイス では、変換と逆変換用の関数を ConvertConvertBack という名前にしている。

引数にとったポインターに結果を戻す関数の場合

  • 変換の結果を引数でもらったポインターに返し、変換がそもそも成功したのかどうかを戻り値で返すような関数。

参考資料