Question

C ++ begginer here。我正在努力获得花括号+ //评论的最佳实践。

我看到，对于上面的函数注释，该定义通过将鼠标悬停在任何位置来提供Visual Studio检查实用程序。但是当谈到if语句和各种各样的句子时，我无法弄清楚在即将开展的项目中最有用的是什么

所以，在

之间

if (condition) {  // comment
    do something();
}

或

// comment
if (condition) {  
    do something();
}

或

if (condition) // comment
{  
    do something();
}

甚至是下一个（使用通常无用的换行符）

if (condition)
{  // comment
    do something();
}

没有明确的“啊，这个因为xyz而更好”，对我而言。

感谢您的远见！

干杯

Answer 1

如果您正在处理个人/个人项目，那么上述任何方式都可以正常工作。但是，我个人会说，如果将if语句写成： -

，我认为if语句看起来更具可读性

if ( a > 10 )
{
    std::cout << "a is above 10" << std::endl;
}

或者单行： -

if ( a > 10 )
    std::cout << "a is above 10" << std::endl;

除非在团体或组织中工作，否则可能需要遵守规则/标准/惯例。

Answer 2

根据注释是应用于条件还是应用于bock，可以不同地处理此示例。第一种情况通常表明条件可能相当复杂，将其重构为单独的变量或使用适当的命名分离方法是有意义的，因此注释（如果仍然有必要）将应用于此变量或方法。第二种情况通常表示您正在执行该块中的复杂操作，并且通过适当的命名将块重构为单独的方法是有意义的，因此注释（如果仍然需要再次）将应用于此方法。请注意，引入具有适当名称的单独实体通常会完全消除对注释的需求。

至于花括号，没有常见的方法，你可能会遇到各种疯狂的大括号。有些人甚至会捍卫这种多元化。当内容不适合一行时，我更喜欢将匹配的大括号 - 水平（在同一行）或垂直（具有相同的缩进）对齐。此规则适用于所有大括号，而不仅仅是卷曲。

c ++花括号和注释

2 个答案: