c - 当程序员意识到这是不好的风格但有必要时，注释应该说什么

Question

简而言之，我有这样的代码。我知道它的风格很糟糕，但经过深思熟虑，其他选择更糟糕。我应该在评论中说什么以​​及应该把它放在哪里？

while(1)
{
    if(x+y == z)//some comparison
    {
        …//do something
    }
    else
    {
        break;
    }
}

Answer 1

假设涉及的代码较多，所以显而易见

while(x+y == z)
{
}

这是不可能的，您可以使用附加变量来标记循环状态。

do_loop = 1;
while (do_loop)
{
    // more code
    do_loop = (x+y == z);
    if (do_loop)
    ...
}

它提供了更多的可能性，尤其是。如果涉及更深层次的嵌套，因为 break; 只会留下最内层的循环。当然，您应该对条件使用更精确的命名，而不是通用的 do_loop，例如coords_are_equal。

如果所有替代方案都更糟糕，包括这个，那么就按原样评论:“发现所有替代方案都比这个更糟糕。”