编码标准/编码C++中的最佳实践

Question

考虑下面的两个代码段.哪一个更好,为什么？如果您有任何其他想法,请提及.我在哪里可以找到像这样的编码实践的答案？如果您知道任何书籍/文章,请分享.

//代码1

bool MyApplication::ReportGenerator::GenerateReport(){
    bool retval = false;
    do{
        if (!isAdmin()){
            break;
        }
        if (!isConditionOne()){
            break;
        }
        if (!isConditionTwo()){
            break;
        }
        if (!isConditionThree()){
            break;
        }

        retval = generateReport();
    } while(0);
    return retval;
}

//代码2

bool MyApplication::ReportGenerator::GenerateReport(){
    if (!isAdmin()  || !isConditionOne() || !isConditionTwo() || !isConditionThree()){
        return false;
    }
    return generateReport();
}

罗伯特C.马丁的清洁代码是一本很好的书来处理这个问题.但是,我想这本书倾向于Java.

更新:

1. 我故意使用do {} while(0); 因为我不想使用goto循环.

2. 我想摆脱这么多if和break语句,所以我提出了Code 2.

我从回复中看到的是Code1和Code2的一组混合响应.与Code 1(我认为更好)相比,有些人更喜欢goto.

Answer 1

我真的不喜欢以这种方式使用do/while循环.另一种方法是将Code2中的条件分解为单独的if检查.这些有时被称为"保护条款".

bool MyApplication::ReportGenerator::GenerateReport()
{
    if (!isAdmin())
        return false;

    if (!isConditionOne())
        return false;

    // etc.

    return generateReport();

}

Answer 2

我个人更喜欢你的第二个代码段的变体.短路将起作用,但条件不太冗长.

bool MyApplication::ReportGenerator::GenerateReport()
{
    if(isAdmin() && isConditionOne() && isConditionTwo() && isConditionThree())
    {
        return generateReport();
    }

    return false;
}

它说一切都在一个干净的地方."如果满足所有这些条件,那么就这样做.否则,不要这样做."

我觉得你的第一个代码段通过将条件分布在12行中使得逻辑变得更难看.此外,封装循环可能会导致某人进行双重操作.

Answer 3

bool MyApplication::ReportGenerator::GenerateReport()
{
   return isAdmin()  
      && isConditionOne() 
      && isConditionTwo()
      && isConditionThree()
      && generateReport();    // Everything's ok.
}

Answer 4

bool MyApplication::ReportGenerator::GenerateReport(){
    if ( ! isAdmin         () ) return false ;
    if ( ! isConditionOne  () ) return false ;
    if ( ! isConditionTwo  () ) return false ;
    if ( ! isConditionThree() ) return false ;
    return generateReport() ;
}

Answer 5

这实际上取决于代码的未来期望.上面的Code1暗示可能为每个条件添加额外的逻辑; 上面的代码2意味着有一个合理的条件分组.如果您希望以后为条件添加逻辑,则Code1可能更相关; 但是,如果你不这样做,Code2可能因为简洁和隐含的分组而更加明智.

Answer 6

我更喜欢修改样本2:

bool MyApplication::ReportGenerator::GenerateReport()
{
    bool returnValue = false;
    if (isAdmin() &&
        isConditionOne() &&
        isConditionTwo() &&
        isConditionThree())
    { 
        returnValue = generateReport();
    } 
    return returnValue;
}

它具有为该功能提供单个出口点的优点,建议使用该出口以便于维护.我发现垂直堆叠条件而不是水平更容易快速读取,如果需要,可以更容易地评估各个条件.