C++花括号和注释

Question

这里是 C++ 初学者。我正在努力了解什么是花括号的最佳实践 + //comments.

我看到对于定义上方的函数注释提供 Visual Studio 检查实用程序，方法是将鼠标悬停在它们的任何地方。但是当涉及到 if 语句和排序时，我无法弄清楚什么对即将进行的项目更有帮助

所以，在

之间

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

或

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

或

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

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

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

我还没有明确的"Ah this one is better because of xyz"。

感谢您的远见！

干杯

Answer 1

如果您正在处理 individual/personal 个项目，那么上述任何一种方法都可以正常工作。但是，我个人会说，如果 if 语句写成这样，我认为它们看起来更具可读性：-

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

或者单行：-

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

除非在团队或组织中工作，在这种情况下可能需要遵循rules/standards/conventions。

Answer 2

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

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

C++花括号和注释

c++ curly braces and comments

c++

comments

coding-style

braces