Açık Kaynak değerinin bir kısmı, yeni bir platform veya dil ile başlayan kişilere mükemmel örnek kod sağlamaktır.

Karşılaştığınız en iyi Açık Kaynak kodu nedir ve neden seçiminizi beğendiniz? Herhangi bir dil yapacaktır, ancak özellikle dikkat çekebileceğiniz en iyi Objective-C örnekleri ile ilgileniyorum.

Açıkçası bu açık uçlu bir soru, bu yüzden soruyu bir süre açık bırakacağım ve ne tür cevaplar aldığımızı göreceğim.

Teşekkürler!

DÜZENLEME: "En iyi" için ben verilen dil veya platformda deyimleri izleyen kodu yanı sıra "profesyonel" kod yapma parçaları dahil düşünüyordum - iyi belgeler, bir test paketi, vb. Özlü kod, ama çok zekice veya konuşkan kod için aşırı zekice tercih edilmez.

Yıllar boyunca açık kaynak kod parçalarına baktığımda, hemen hemen tümüyle hayal kırıklığına uğradım.

Benim için asıl tahriş, genellikle çok az yorum olması, sıklıkla sadece yorumların uzun ve yasal bir telif hakkı uyarısı olmasıdır.

Linux çekirdeği, dosyaların sıklıkla hangi amaca hizmet ettiklerini söyleyen bir yorumu olmadığı bir örnektir (örneğin, XYZ için sürücü en azından kabaca doğru yerde olduğumu söyler).

Kodlama standartlarının sadece bir kod biriminin ne yaptığını söylemek için mantıklı anlaşılır yorumlar gerektirdiği ticari ve savunma programlarından geldim, ancak kod aracılığıyla algoritmaları, yöntemleri, özellikleri, hackleri / akıllı şeyleri tanımlayan yorum blokları olmalı Böylece, her kim gelirse, gerçek kodda titizlikle dolaşmak yerine ne yapıldığını HIZLI olarak görebilir ve anlayabilir.

Belki de ahlaki: Bana ne yaptığını söyle, anlamama izin verme.

Bunu iyi yapan herhangi bir açık kaynak kodu bulamadım. İyi kodlama uygulamalarını öğrenmenin bir aracı olarak açık kaynak aramaya gelince, sarılık tavsiyem: Yapmayın.

Sqlite kod tabanı hakkında çok iyi şeyler duydum .

Ben içine bakmış küçük, çok temiz görünüyor.

Donald Knuth, matematiksel formüllerini kitaplarında yayıncısından daha iyi yazmasına yardımcı olmak için iki program yazdı.

Bu iki program (son sürümlerinde), kaynak kodun basılı, dizilmiş bir versiyonunu oluşturmaya izin veren Literate Programming kullanılarak yazılmıştır ve bunlar kitap olarak yayınlanmıştır. Bunlar şimdiye kadar okuduğum en iyi belgelenmiş programlardır!

• "Bilgisayarlar ve Dizgi Oluşturma, Cilt B: TeX: Program"
• "Bilgisayarlar ve Dizgi Oluşturma, Cilt D: Metafont: Program"

Çevrimiçi okuma için kullanılamazlar, ancak Amazon size http://www.amazon.com/Computers-Typesetting-D-Metafont-Program/dp/0201134381/ adresindeki Metafont kitabını da "İçine Bak" olanağı veriyor.

Uyarı: Ağır şeylerdir, bu yüzden her kitap 600 sayfada çalışır.

Güzel Kod kitabı bu soruyu katkıda bulunanların açık kaynak projelerinden güzel kodun örnekleri olduğunu düşündüklerinin birkaç örneğiyle cevaplamaya çalışmaktadır.

CodeIgniter

Bir işletim sistemi projesinde gördüğüm en temiz, en iyi belgelenmiş kaynak kodlarından bazıları.

Çok iyi yapılandırılmış 2 proje gördüm:

1. Django
2. Krom projesi

Özellikle, ikincisi birkaç şeye dayanarak çok ilginç:

• Birçok şey için işlemleri nasıl kullanır (sekmeler, eklentiler) ve birbirine nasıl uyar
• her Windows, Mac, Linux için yerel GUI'ye sahip çoklu platform
• web kiti entegrasyonu

Ayrıca Postgre'nin temiz yazıldığını duydum (MySql'in aksine), ama kendim okumadım.

Bazıları Linux Çekirdeği için C kodunun oldukça iyi olduğunu söylüyor .

(Anladığım kadarıyla değil! Muhtemelen en iyi yazılmış açık kaynaklı C projesi.)

LLVM kaynak kodunun çok okunabilir olduğunu gördüm . Eminim gördüğüm en temiz C ++. Buna aşina değilseniz, temel olarak bir derleyici inşaat araç takımıdır.

• Kapsamlı bir test paketi vardır. Aslında en az iki tane var: test özellikleri için bir set ve performansı test etmek için bir set (LLVM'nin kendisi ve oluşturduğu derlenmiş programlar).
• Kod iyi yorumlanmıştır.
• Yüksek düzeyde tekrarlanan kod (çeşitli arka uçlarda talimat eşleştirme gibi), daha yüksek düzeyli bir DSL (TableGen olarak adlandırılır) tanımından otomatik olarak oluşturulur.
  • Bu aynı zamanda, birden fazla ayrık kod parçasının aynı açıklamadan üretilmesine izin verir. Örneğin, arka uç spesifikasyonu bir derleyici arka ucunun parçası olarak kullanılır, aynı zamanda montajcılar ve sökücüler için de kullanılır.
• Oldukça iyi belgelere sahip.

Bu oldukça büyük bir proje, bu yüzden her şeyin nasıl çalıştığını hızlı bir şekilde anlayabilmeyi beklemeyin. Ancak, üst düzey bir genel bakış elde etmek oldukça kolay olmalıdır.

Bu büyük bir proje değil, ama SubSonic ORM'yi kesmek benim için son derece kolaydı. Tam olarak ihtiyacım olanı değiştirebildiğim ilk gerçek açık kaynaklı projeydi. Diğerlerinin çoğunu kaynağa baktım ve kafamı duvara vurdum. Ben kısmen PostgreSQL (SQL Server sağlayıcı şey dayalı) birkaç saat içinde destek vardı. Şimdiye kadar gördüğüm en iyi organize edilmiş proje ... birçok açık kaynak projesine baktığımı söylememe rağmen.

İlk olarak basit bir örnek: Olay işleme sistemi zope.event için kod. Olayları farklı olay dinleyicilerine gönderen başka olay sistemleri kullanmıştım. Zope.event kodunu gördüğümde, bazı şeylerin ne kadar basit olabileceğini anladığımda facepalm zamanıydı.

Python ile yazılmış ve işte kodun tamamı:

subscribers = []

def notify(event):
    """ Notify all subscribers of ``event``.
    """
    for subscriber in subscribers:
        subscriber(event)

Abone eklemek için bunu yaparsınız:

from zope.event import subscribers
subscribers.add(MySubscriber())

Gördüğüm en iyi KISS örneği.

Daha karmaşık bir örnek: Mars kod tabanı, bazı akıllı Python kesmek kullanıyor olsa da, çok güzel ve okunması kolay. Aynı şey Marslı kullanılarak yapılan Grok kodunun çoğu için de geçerlidir.

Açık Kaynak Uygulamalarının Mimarisi adlı bu kitabı okumayı düşünün . Kitapta tartışılan projelerde tasarım kararlarının neden ve nasıl verildiğine dair bir eleştiri vermelidir.

Sizi uzun süre atlatabilecek en iyisini aramak yerine, belki de kitabın kapsamı dışında bazı projelerin tasarımını takdir etmeye çalışın. Bu, hatalarını tekrarlamak (veya popüler olarak adlandırıldığı gibi, tekerleği yeniden keşfetmek) yerine bu projelerin başarılarını geliştirmenize yardımcı olabilir.