您创建或审核的代码评论有哪些“禅”时刻？

Question

我正在寻找合理简短但相当复杂的代码段（对象，函数，类，一组特定的变量名称等）的示例，这些代码可以实现完美的禅，例如自我文档和实现优雅的平衡。

它可能是你真正引以为傲的东西，也可能是你遇到过的东西，经历过“啊哈！”启蒙的时刻。

一些潜在的标准（并非所有标准都需要满足）：

• 稀疏和专注
• 不言而喻。也许这么清楚，即使非程序员也能理解你想要做什么，即使他们不理解语法或实现细节。
• 明显有用（有多个用例，例如排序算法，方便的递归方法等）
• 巧
• 燃灯
• 生产质量和功能（例如非伪代码）

我正在寻找一个示例代码段，然后简要评论代码的特殊之处。当然，最好的例子只需要很少的额外评论，因为它们都有很好的文档记录。

对版主说：我是stackoverflow的新手，所以如果这个问题不合适或者必须关闭，你能解释一下它与stackoverflow规范的对比吗？我不打算浪费人们的时间。

这个问题的目标是通过社区提供和评定的示例来学习良好的评论实践。

Answer 1

Jon Bentley在C Quicksort一书中对Programming Pearls的实施。

void quicksort(int l, int u) {
    int i, m;
    if (l >= u) return;
    swap(l, randint(l,u));
    m = l;
    for (i=l+1; i<=u; i++)
       if ( x[i] < x[l] )
           swap(++m, i);
    swap(l, m);
    quicksort(l, m-1);
    quicksort(m+1, u);
}

这真是太不可思议了。优雅，简洁，简约，高效。特别是，我建议在Beautiful Code的第3章中对此算法进行分析。令人兴奋！

Answer 2

我建议你阅读Beautiful Code。这是你所追求的一个很好的例子。