“应该取消”的返回值

Question

我有一个方法 DoCleanUp()，它将要求用户继续，然后清除当前工作区。如果用户选择取消此过程，它将返回。

我的问题是，哪个签名最能表明“取消”？

1. bool DoCleanUp(); // 返回 false 表示已取消。

2. bool DoCleanUp(); // 返回true表示应该取消该方法。

3. void DoCleanUp(bool&cancel); // 检查参数“cancel”以查看此方法是否被取消。

更新： 至于语言，是 C++\CLI 或 C#。

UPDATE2：现在假设我必须在 DoCleanUp 方法中保存一个文件。我将提示一个对话框，询问用户是否保存/不保存/取消文件。根据答案，我得出以下结论：

void DoCleanUp();

DialogResult AskToSaveFile(); // return yes/no/cancel

void DoCleanUp( bool saveFile );

用法：

void DoCleanUp()
{
    DialogResult result =  AskToSaveFile();

    if( result == DialogResult::Cancel )    return; 

    bool saveFile = (result == DialogResult::Yes) ? true : false;
    DoCleanUp( saveFile );
}

然后通过调用 DoCleanUp()，您知道用户将有机会取消；
通过调用DoCleanUp(bool saveFile)，您可以控制是否保存文件，而无需询问用户。
这样看起来更好吗？

Answer 1

令人困惑的地方是调用它 DoSomething()，而它可能什么也不做。怎么样？

if (QueryCleanup())     // boolean
    DoCleanup();        // void

更详细但更清晰，即使没有看到声明。

Answer 2

您不应将布尔值用于状态（或状态消息）。创建一个枚举：

public Enum CleanupStatus
{
    Ok = 0,
    Cancel
}

这样可以更清楚返回值是什么……如果您需要添加更多状态，也可以。

（这全部来自《Code Complete 2》，如果你还没有读过，你应该阅读它。）

Answer 3

基本上你有两个要求。外部请求是创建一个新的工作区。内部请求是保存当前工作空间。如果外部请求继续，您希望返回 true；如果外部请求中止，您希望返回 false。内部请求的操作对于外部请求并不重要，因此应该是某种委托/函子/闭包。

创建一个类来泛化它：

class YesNoCancel {
   string question; // question to ask the user about the inner state
   delegate doit; // function to call to 
   delegate dontdoit;
public:
   YesNoCancel(string question, delegate doit, delegate dontdoit = null) {...}

   bool run() {
     switch (AskUser(question)) {
     case ANSWER_YES: doit(); return true;
     case ANSWER_NO: return true;
     case ANSWER_CANCEL: if (dontdoit) dontdoit(); return false;
};

//usage

void NewWorkspace() {
    if (m_workspace) {
        YesNoCancel ync("Save current workspace?", saveworkspace);
        if (!ync.run()) return;
    }
    // new workspace code
}

void CloseApp() {
    YesNoCancel ync("Save current workspace?", saveworkspace);
    if (ync.run()) ExitApplication();
}

Answer 4

我相信选项三给出了最清晰的信息。当您将 bool 作为返回类型时，并不能立即清楚它的用途。

Answer 5

我通常会选择，

 bool DoCleanUp();  // Returns true if cancel

但主要取决于调用代码是否如下所示：

 if (DoCleanUp()) {
     // Do cancel up code
 }

或：

 if (DoCleanUp()) {
     // Do non-cancel post clean up code
 }

基本上，我尝试使我的测试不必使用 ! 或等效语言，因为我发现很难看到。

我绝对不会做第三点。

Answer 6

我更喜欢第三个签名，只是因为通过查看它（没有任何额外的文档），我可以更多地了解该方法的作用。不过，我会把这个论点称为更明确的东西，比如 processCancelled。

Answer 7

这是一个典型的单一责任问题。

您不确定签名的原因是该方法正在做两件事。

我将创建 2 个方法：

bool CheckIfTheUserWantsToCancel()
void DoCleanUp()

编辑

根据对问题的评论和编辑，我将创建第三个方法：

void SaveFile()

DoCleanUp 将首先调用 CheckIfTheUserWantsToCancel，然后如果未取消，将调用 SaveFile。

恕我直言，这比尝试记住参数为 false 的 DoCleanUp 将在不询问用户的情况下保存文件要好得多，还是相反？

Answer 8

如果没有更多细节，我会说答案 1 是最好的恕我直言。第三个相当难看，因为它需要更多代码来调用。

但也许考虑将代码重写为这

void CleanUp() {
   switch (AskUser()) {
     case ButtonOk: CleanUpDesk(); break;
     case ButtonNo: break;
     default:
     case ButtonCancel: CancelCleanUpDesk(); break;
   }
}

似乎本着单一责任的精神。我的代码以某种方式将您的问题分为两个步骤：询问用户并执行操作。

Answer 9

我会使用你的 1 版本。

bool DoCleanUp(); // return false to indicate canceled.

假设是，清理完成后它返回 true。返回 false 将指示“错误”状态。返回一个 int 甚至可能是有意义的。在这种情况下，约定通常是 0 代表成功，其他所有内容都是错误代码。

无论您做出什么决定，请记录您的返回值的含义！