如何從一個方法返回可選的調試信息？

Question

比方說，我有一個靜態方法，比較兩個對象的近距離匹配並返回一些置信度[0,1]。

class Foo 
{ 
    ... 
    static double Compare(const Foo& foo1, const Foo& foo2); 
    ... 
}; 

現在我需要返回一個包含具體取決於配置的設置比較細節的其他調試信息。 由於此調試信息不​​會在生產中使用，但僅用於測試/調試目的，我想知道實現它的適當方式是什麼。

我看到至少有三個選項：

1：創建一個附加的類CompareResult和存儲信心+可選信息存在。如果您不需要，請不要填充可選信息。

class CompareResult 
{ 
    ... 
private: 
    double confidence_; 
    CompareOptionalInfo compare_optional_info_; 
    ... 
}; 

... 

static CompareResult Compare(const Foo& foo1, const Foo& foo2); 

它似乎是最乾淨的一個，但我不確定是否應該將返回結果與可選信息結合使用。

2：使用輸出變量（這樣，我們將不再需要創建一個額外的類，但我們的方法簽名將增長一點）

static double Compare(const Foo& foo1, const Foo& foo2, CompareOptionalInfo* out_compare_info = nullptr); 

3：單獨的比較方法可選，信息檢索方法。

static double Compare(const Foo& foo1, const Foo& foo2); 
static CompareOptionalInfo GetCompareOptionalInfo(); 

此選項可能會需要存儲方法調用之間的可選-信息，並從靜態轉向比較方法的實例進行比較的方法。 但是，我不確定它是否合適。

從您的經驗來看，OOP世界中從方法返回可選信息（大多隻用於調試模式）的適當方式是什麼？

Answer 1

選項3是不是一個好主意都：根據靜態數據具有的功能是不實際的，可能變得更成爲調試中的錯誤來源。這樣的設計另外不是線程安全的;多麼可惜，爲了調試目的而創建這樣的限制！問題

例子：

double closest = std::max (Foo::compare (x, y), Foo::compare (y,z)); 
clog << Foo::GetCompareOptionalInfo(); // undefined which info since order of eval 
             // of function parameter is not guaranteed 

double d = Foo::compare (x, y); 
DoSomething();     // what if this one does an unexpected compare ? 
clog << Foo::GetCompareOptionalInfo(); 

---

選項2是一個可行的解決方案，但它是不是很方便：它迫使你創建信息對象，通過地址等通過他們：

Foo::OptionalCompareInfo o1,o2; // cumbersome 
double closest = std::max (Foo::compare (x, y, &o1), Foo::compare (y,z, &o2)); 

此外，您還可以創建這些可選信息並在生產中傳遞額外的參數，即使您不再更新其中的信息（除非你把很多額外的條件編譯）！

---

選項1是優秀的！去吧 ！它確實利用了OOP範例，並使用了一個乾淨的設計。使用它並且不要強制使用它的代碼約束是實用的。

所有你需要的是提供使用您CompareResult幾乎一樣，如果它是一些（隱含的）轉換功能的double：

class CompareResult 
{ 
public: 
    CompareResult(double d=0.0) : confidence_(d) {}; 
    operator double() { return confidence_; } 
    operator bool() { return confidence_>0.5; } 
private: 
    double confidence_; 
    CompareOptionalInfo compare_optional_info_; 
}; 

online demo

你的生產代碼是由調試信息未受影響。而你可以在你的調試總是追溯到任何給定的比較結果的解釋，至少如果你保存它：

例子：

auto result = Foo::compare (x, y) 
if (result) ... // uses automatically the conversion 

auto closest = std::max (Foo::compare (x, y), Foo::compare (y,z)); 
// here you not only know the closest match but could explain it ! 

vector<CompareResult> v; 
... // populate the vector with 10 000 comparison results 
auto r = std::max_element(v.begin(), v.end()); 
    // you could still explain the compare info for the largest value 
    // if you're interested in the details of this single value 
    // how would you do this with option 3 or option 2 ?  

好了，對於最後一個工作，你會還需要您的額外班級的比較運算符。但是，這是一行代碼更多（請參閱在線演示）;-)

最後，它可能會證明您的「可選調試信息」可能證明比預期更有用，例如爲用戶提供額外的解釋根據要求。所有你需要做的事情就是刪除圍繞可選信息計算的條件#ifdef DEBUG。

Answer 2

我會使用第二個選項來與調試器兼容。

在調試模式下，您可以添加一個額外的靜態成員。你應該照顧不應該壓制它的鏈接器。

class Foo 
{ 
    private: 
#ifndef NDEBUG 
    CompareOptionalInfo debug_out_compare_info_; 
#endif 

    ... 
    static double Compare(const Foo& foo1, const Foo& foo2, 
     CompareOptionalInfo* out_compare_info = nullptr); 
    ... 
}; 

#ifndef NDEBUG 
CompareOptionalInfo Foo::debug_out_compare_info_; 
#endif 

在gdb中，在任何斷點，可以使用：

call Foo::Compare(foo1, foo2, &Foo::debug_out_compare_info_); 
print Foo::debug_out_compare_info_. ...