私は、自己文書化と実装の優雅さの完璧な禅のようなバランスを打ち出す、適度に短いが適度に複雑なコードのセグメント (オブジェクト、関数、クラス、特定の変数名のセットなど) の例を探しています。
それはあなたが本当に誇りに思っていることかもしれませんし、あなたが出会って「ああ！」を経験したことかもしれません。悟りの瞬間。
いくつかの潜在的な基準 (1 つの例ですべてを満たす必要はありません):
- まばらで集中
- 自明。おそらく非常に明確に書かれているので、プログラマーでなくても、構文や実装の詳細を理解していなくても、あなたがやろうとしていることを理解できるでしょう.
- 明白に有用 (ソートアルゴリズム、便利な再帰メソッドなど、複数のユースケースがあります)
- 頭がいい
- 啓蒙
- 製品の品質と機能 (例: 疑似コードではない)
コードの特別な点についての簡単な解説が続くサンプル スニペットを探しています。もちろん、最良の例は十分に文書化されているため、追加のコメントは最小限で済みます。
モデレーターへの注意: 私は stackoverflow を初めて使用するので、この質問が何らかの形で適切でないか、クローズする必要がある場合は、stackoverflow の規範に違反している箇所について説明を提供していただけますか? 私は人々の時間を無駄にするつもりはありません。
この質問の目標は、コミュニティによって提供および評価された例を通じて、適切なコメントの実践を学ぶことです。