namazu-dev(ring)


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

naming rule (Re: util.(add PREFIX nmz_))



Abe Ryuji <raeva@xxxxxxxxxxxx> wrote:

>s/strcasestr/nmz_strcasestr/g
>s/strlower/nmz_strlower/g
>s/strprefixcasecmp/nmz_strprefixcasecmp/g
>s/strprefixcmp/nmz_strprefixcmp/g
>s/strsuffixcmp/nmz_strsuffixcmp/g
>s/isnumstr/nmz_isnumstr/g
>s/issymbol/nmz_issymbol/g
>s/safe_getenv/nmz_getenv/g
>s/commas/nmz_commas/g
>s/freadx/nmz_fread/g
>s/getidxptr/nmz_getidxptr/g
>s/decode_uri/nmz_decode_uri/g
>s/print/nmz_print/g
>
>これでutil.[ch]に関しては作業の大半が終ったと思います。

ありがとうございます。


>ところで、
>
>: s/getidxptr/nmz_getidxptr/g
>
>ここはgetidxptrよりはget_index_ptrの方がわかりやすいような気がしますが、
>いかがでしょうか?

getidxptr() は 1.3.0.10 では get_index_pointer() という名前
でした。が、長すぎると感じたので getidxptr() に改名しました。

命名規則の原則は、

  * ローカルな変数・関数には短い名前を
  * グローバルな変数・関数には長い名前を

です。が、なかなか難しいです。まだ確固たる方針はありません。

「すべてのグローバルな変数・関数の名前は略さない、単語間には
必ず `_' を入れる」という方針にすれば、略す・略さない、くっ
つける・くっつけない、で迷うことはなくなりますが、短い名前の
魅力も捨てがたいです。

# initialize_parser() より init_parser()、add_index_name() 
# より add_idxname() の方がかわいいと思いません?

大規模なソフトウェアではいやでも長い名前をつけざるを得ないの
だろうけど…。

命名規則について何か考えがあればお聞かせくださいませ。 > みなさま
(どんな命名規則が一般的なのだろうか?)

# get_index_pointer() のように `_' が 2つ以上、含まれると間
# 延びしてかっこ悪い気がするけど、 getIndexPointer() なら気
# にならない。長い名前をつけるなら Java風がいいみたい。(趣味
# の問題)

p.s.
講義の関係もあって『デザインパターン』を読んでいます。文章は
退屈 (冗談や面白い逸話の類いは皆無) だけど、内容は役立つこと
が書かれています。:-)
<http://books.softbank.co.jp/bookweb.nsf/9fa25b1ce136e388492566350001573c/93e623a6f03454d14925679800455cce?OpenDocument>

-- Satoru Takabayashi
おまけ:
一番長い英単語は floccinaucinihilipilification だそうです。

ランダムハウス英語辞典 floc・ci・nau・ci・ni・hil・i・pil・i・fi・ca・tion
| ■n.
| 《まれ》無価値とみなすこと,(物の価値の)軽視.
| ▼英語で最も長い単語の例として引き合いに出される.
| [1741.<ラテン語 flocci ̄+nauci ̄+nihili ̄+pili ̄(すべて「ほ
| とんど価値のない,価値の全くない,ささいな」の意)+-FICATION]