Parte del valore di Open Source è fornire un ottimo esempio di codice alle persone che iniziano con una nuova piattaforma o lingua.

Qual è il miglior codice Open Source che hai incontrato e perché ti piace la tua scelta? Qualsiasi linguaggio lo farà, ma sono particolarmente interessato ai migliori esempi di Objective-C che puoi sottolineare.

Ovviamente questa è una domanda a risposta aperta, quindi lascerò la domanda aperta per un po 'e vedremo che tipo di risposte otteniamo.

Grazie!

EDIT: per "meglio" stavo pensando a un codice che segue i modi di dire nella lingua o piattaforma specificata, oltre a includere le parti che rendono il codice "professionale" - buona documentazione, una suite di test, ecc. Codice conciso, ma preferibilmente non troppo intelligente è un codice molto conciso o chiacchierone.

Devo dire che dopo aver esaminato frammenti di codice open source nel corso degli anni, sono stato enormemente deluso da quasi tutto.

La principale irritazione per me è che di solito ci sono pochissimi commenti, spesso i soli commenti sono un lungo e legale avviso sul copyright.

Il kernel di Linux è un esempio in cui i file spesso non hanno nemmeno un commento in essi che dice a quale scopo servono (ad esempio il driver per XYZ mi direbbe almeno che sono nel posto giusto).

Sono venuto dalla programmazione commerciale e di difesa in cui gli standard di codifica richiedono commenti comprensibili sensibili non solo per dire cosa fa un'unità di codice, ma attraverso il codice ci devono essere blocchi di commenti che descrivono algoritmi, metodi, peculiarità, hack / cose intelligenti , tutto in modo che chiunque venga dopo possa guardare e capire RAPIDAMENTE ciò che viene fatto invece di scrutare minuziosamente il codice attuale.

Forse la morale è: dimmi cosa stai facendo, non farmi capire.

Non ho trovato NESSUN codice open source che funzioni bene. Per quanto riguarda la ricerca dell'open source come mezzo per apprendere buone pratiche di codifica, il mio consiglio itterico è: Non farlo.

Ho sentito cose molto positive sulla base di codice Sqlite .

Dal poco che ci avevo guardato, sembra molto pulito.

Donald Knuth scrisse due programmi per aiutarlo a comporre le sue formule matematiche nei suoi libri meglio del suo editore.

Questi due programmi (nella loro versione finale) sono stati scritti usando Literate Programming che ha permesso di creare una versione stampata e composta del codice sorgente e sono stati pubblicati come libri. Questi sono semplicemente i migliori programmi documentati che abbia mai letto!

• "Computer e composizione, volume B: TeX: il programma"
• "Computer e composizione, volume D: Metafont: il programma"

Non sono disponibili per la lettura online, ma Amazon ti consente anche di "Guardare dentro" il libro Metafont su http://www.amazon.com/Computers-Typesetting-D-Metafont-Program/dp/0201134381/

Avvertenza: è roba pesante, motivo per cui ogni libro ha una durata di 600 pagine.

Il libro Beautiful Code cerca di rispondere a questa domanda con diversi esempi di ciò che i partecipanti pensano siano esemplari di bellissimo codice da progetti open source.

CodeIgniter

Alcuni dei codici sorgente più puliti e meglio documentati che ho visto da un progetto OS.

Ho visto 2 progetti molto ben strutturati:

1. Django
2. Progetto Chromium

In particolare, il secondo è molto interessante in base a poche cose:

• Come utilizza i processi per molte cose (schede, plug-in) e come si adatta insieme
• multipiattaforma con GUI nativa per ogni Windows, Mac, Linux
• integrazione web-kit

Inoltre ho sentito che Postgre è scritto in modo pulito (al contrario di MySql), ma non l'ho letto da solo.

Alcuni sostengono che il codice C per il kernel Linux sia dannatamente buono.

(Non che io capisca la cosa! È probabilmente il miglior progetto C open source scritto in circolazione.)

Ho trovato il codice sorgente LLVM molto leggibile. Sono abbastanza sicuro che sia il C ++ più pulito che abbia mai visto. Se non lo conosci, è fondamentalmente un toolkit di costruzione di compilatori.

• Ha una vasta suite di test. Bene, in realtà ne ha almeno due: un set per testare le funzionalità e uno per testare le prestazioni (di LLVM stesso e dei programmi compilati che genera).
• Il codice è ben commentato.
• Il codice altamente ripetitivo (come la corrispondenza delle istruzioni nei vari backend) viene generato automaticamente da una descrizione DSL di livello superiore (chiamata TableGen).
  • Ciò consente anche di generare più pezzi di codice disgiunti dalla stessa descrizione. Ad esempio, la specifica del back-end viene utilizzata come parte di un back-end del compilatore, ma anche per assemblatori e disassemblatori.
• Ha una documentazione abbastanza buona.

È un progetto piuttosto grande, quindi non aspettarti di essere in grado di capire rapidamente come funziona tutto. Ma dovrebbe essere abbastanza facile ottenere una panoramica di alto livello.

Non è un grande progetto, ma il SubSonic ORM è stato estremamente facile da hackerare. È stato il primo vero progetto open source che sono stato in grado di modificare esattamente come mi serviva. La maggior parte degli altri ho finito per guardare la fonte e sbattere la testa contro un muro. L'ho avuto parzialmente supportando PostgreSQL (basandolo sulla cosa del provider SQL Server) entro poche ore. È il progetto più ben organizzato che abbia mai visto ... anche se non per dire che ho visto molti progetti open source.

Innanzitutto un semplice esempio: il codice per il sistema di gestione degli eventi zope.event. Avevo usato altri sistemi di eventi, che inviavano eventi a diversi ascoltatori di eventi. Quando ho visto il codice zope.event era il momento di facepalm, quando ho capito quanto potevano essere semplici alcune cose.

È scritto in Python, ed ecco il codice nella sua interezza:

subscribers = []

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

Per aggiungere un abbonato, procedere come segue:

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

Il miglior esempio di KISS che ho visto.

Quindi un esempio più complesso: la base di codice marziano è molto bella e facile da leggere, anche se sta usando alcuni hack intelligenti di Python. Lo stesso vale per la maggior parte del codice di Grok, che viene creato utilizzando Martian.

Considera di leggere questo libro The Architecture of Open Source Applications . Dovrebbe darti una critica del perché e del modo in cui le decisioni di progettazione sono state prese nei progetti discussi nel libro.

Invece di cercare il meglio, che può sfuggirti a lungo, prova ad apprezzare il design di alcuni progetti, forse oltre lo scopo del libro. Ciò potrebbe aiutarti a sfruttare i successi di questi progetti invece di ripetere i loro errori (o, come viene comunemente chiamato, reinventare la ruota).