関数の戻り値 TrueとFalseの使い分けについて

Question

関数の戻り値に真偽値を使用する場合、以下の2つの考え方を耳にします。

1. TrueとFalseの語源から、
   1.1 正常終了の場合 : True
   1.2 異常終了の場合 : False

---

1. 正常終了のステータスコードが0, エラーが1で、
   Trueが1、Falseが0であるので、
   1.1 : 正常終了の場合 : True
   1.2 : 異常終了の場合 : False

---

どちらの言い分にも一理あり、どちらがいいかは人によるとは思います。
ですが、チームで開発する以上、方針はどちらかに決めるべきだと思うのですが、一般的にはどちらが採用されるのでしょうか。

また、こういったコーディング規約をまとめたガイドラインなどはないのでしょうか。

Answer 1

結論は「どちらの言い分も的外れ」ですね。

関数にしろ変数にしろ、それがどんな機能を持っているかを明確にして命名すべきであり、そこのところが全然分かっていないからtrueを返すべきかfalseを返すべきか、みたいな、頓珍漢な事で悩むんでしょう。

bool judge(int a){} みたいな命名してたりするんじゃないですか？

bool canDivideBy3(int a){} なら、与えられたaに対してどっちが返るべきかは一目瞭然だと思いますけど。

着目すべき場所がおかしいんですよ。

フレームワークとかでModelの大元の呼び出しとかはどうしたらええの？ bool Model::exec(){} やねんけど、みたいなのはまぁ、好きにしたら良いんじゃないですかね。

だからまぁ、ステータスじゃなくフラグを返す関数なのに良い命名ができないとしたら、それは関数がでか過ぎて機能が複雑だって事なんですよね。そしたら何をすべきかも見えてくるでしょ。

Answer 2

真偽を返却する、ということに対して、これ以上決める方針はないですよね。
多分、

1.正常終了のステータスコードが0, エラーが1で、Trueが1、Falseが0であるので、

からの記述については誤記で、

2.正常終了のステータスコードが0, エラーが1で、Trueが1、Falseが0であるので、
2.1 : 正常終了の場合 : False
2.2 : 異常終了の場合 : True

ではないですか？
そうだと仮定して、質問を以下に解釈して回答します。

正常/異常を真偽で返却する時に、どちらをTrue/Falseにしますか？

正常=Trueの方が誤解しないと思います。

エラーステータスの場合の主語はエラーであるのでエラーで無い時に0とするのは一般的で、
かつエラーの内容で細かく1,2,3・・・などと拡張したりしますが、前提として正常/異常の２値だけで扱うのは既に別物です。

それでも同様に主語をエラーにしたエラーステータスとするなら、異常=Trueとすれば筋は通っていますが、真偽という２値にした時点で、真/偽=正常/異常と解釈する人の方が多いと思われます。

関数の名前次第ですが、IsNull()とかIsError()とか関数名が処理を明確に表しているなら誤解はないですが、エラーステータスを引き合いに出される位なので、そういった処理ではないのでしょう。
主語をエラーにしない、例えば「実行結果」として、正常/異常=True/Falseとするのが良いのではないでしょうか。

Answer 3

もっと言語なり環境なりを限定しないとなんとも言えませんが、真偽値を返す関数ならば、真を返すのも偽を返すのも正常終了というのが一般的かと思います。たとえば、「人を引数にとって選挙権があるかどうか返す関数」なら、年齢や住民票などをもとに判定して、選挙権があるなら真値、ないなら偽値を返しますが、どちらも正常終了でしょう。
こういう場合、例外機構があれば異常終了は例外を投げるのでしょう。先の関数で人じゃなくて犬が引数に与えられた、とか。