2011-01-11 15 views
2

2つの関数が必要です。
1. DBからプレーンテキストを取得します。 1に基づいて
2、リッチテキストを取得する - などの新しいライン、フォントスタイルであなたは1人気に基づく名前付け機能

あなたは1つのテキスト()及び2に名前を付けるだろう機能2は、機能よりもはるかに使用されることを期待し

- rich_text()、または2の名前にもっと単純なtext()を使うでしょう?なぜなら、より一般的で、plain_text()のようなものを1に使うことが予想されるからです。

もっと一般的な質問です。名前を付けるときに、機能の期待される「人気」を考慮しますか?

+3

私は好きな関数 'happy_happy_joy_joy()'を呼び出すつもりですので、誰もがそれを愛し、それが何をするのかを半分を与えずに使用します! – BoltClock

+0

私はリッチテキストが嫌いです。 – Thilo

+0

@ティヒロ、あなたは詳しく教えていただけますか? –

答えて

3

いいえ、私は機能の人気を考慮しません。両方の機能にわかりやすい名前を付けるのが最善です(例:plain_text()と1つはrich_text()です)。

より一般的な名前を使用しているので、すべての関数に比較的固有の名前を使用することが最善の方法だと思います。)は、ユーザーが名前を読み取ることによって関数が何をするのか、混乱につながる可能性があります。

もちろん、関数の名前はどのように指定しますか:わかりやすい名前を付け、名前を付けて(そして引数を並べる)ことを一貫してお勧めします。

私はこれまで慣れていたにもかかわらず、すべての関数名が簡潔でわかりにくいAPIを使ってプログラミングすることを嫌いにしています - strstrstrtokは直感的な名前ではありません行う)。

2

コードが非常に広く使用されるようになる場合は、人気について考えてみる価値があります。自然言語の一般的な言葉は短い傾向にあります。

あなたが次のUNIXを書いていると思っているのでなければ、名前を説明的にして長さを心配するのではないでしょうか。

私はgetPlainText()getRichText()に行きます。

+1

しかし、Ken Thompsonでも 'creat()'から 'e'を残してしまったので、次のUNIXを書いているのなら**自然言語を考慮してください。 –

+0

ええ、しかし、私はgetThingAndResturnAsJsonForDojoDataのような名前に実行されるコードを扱ってきました。地獄のように説明的だが、扱いが難しい。 –

1

おおまかに言えば、私はいつも自分の行いたいことに基づいて自分の機能に名前を付けます。私があなたの靴の中にいたなら、私は機能一つをretrieve_plain_text()と機能2という名前にしますretrieve_rich_text()。どちらの関数名でも見ることができ、関数が何をすべきかをすぐに理解することができます:Retrieve(この場合はデータベースから取得)plain/rich(型)のテキスト。

関連する問題