Consiglia un progetto open source con commenti di qualità in un buon inglese

Question

L'inglese non è la mia lingua madre. Tuttavia, devo scrivere commenti in inglese. Voglio migliorare il mio "commento in inglese" studiando un pezzo di codice che è commentato in un buon inglese. Si prega di raccomandare un progetto open source che contiene molti commenti significativi scritti da persone con un'ottima padronanza della lingua.

Answer 1

Posso consigliare la Collezione Puzzle di Simon Tatham.

I commenti che ho letto sembrano un inglese corretto per me. Inoltre, sono chiaramente scritti e contengono informazioni utili sul perché le cose vanno fatte così come sono.

La documentazione per gli sviluppatori è anche di facile lettura e comprensione e, come vantaggio secondario, leggerai la documentazione di un sistema con una buona e semplice architettura.

Se miri a leggere qualcosa e poi emularlo senza capire esplicitamente perché farlo sia una buona idea, posso sicuramente consigliare i puzzle di ST. Se vuoi una comprensione esplicita di cosa sia una buona scrittura, penso che i puzzle di ST serviranno da buon esempio , ma vuoi davvero leggere qualcosa come Strunk e White.

Answer 2

Non credo che i commenti siano un buon posto per imparare, anche se devi emulare questo stile. I commenti spesso non sono nemmeno corretti in inglese e i buoni progetti non avranno comunque troppi commenti, quindi non c'è molto da cui imparare.

Se, d'altra parte, prendi un progetto ampiamente commentato, puoi essere quasi sicuro che non è un grande modello di ruolo poiché i programmatori non erano in grado di trasmettere un significato conciso. Questa è una generalizzazione, ovviamente. Tuttavia, credo che (quasi?) Sia sempre vero. YMMV.

Invece, impara l'inglese studiando gli esperti. C'è stata una domanda al riguardo. Ho raccomandato & # 8220; On Writing Well & # 8221; di William Zinsser e lo farò di nuovo.

(A proposito, neanche l'inglese non è la mia madrelingua.)

Answer 3

Ne ho sempre guardato solo piccoli pezzi, ma ho sentito che il kernel di Linux è molto ben commentato.

Answer 4

Ho sempre pensato che Angband sia ben commentato.

Answer 5

Ho un progetto open source abbastanza ben commentato è Drupal. Dai un'occhiata a Drupal.org . Ho sviluppato diversi portali e puoi effettivamente imparare un po 'leggendo i commenti nei moduli e nei temi. In realtà sono alcune volte più informativi della documentazione.

Answer 6

Minix è abbastanza ben commentato. Possono essere un po 'concisi in alcuni punti ma i commenti sono molto utili.

Answer 7

Inoltre, se vuoi migliorare la tua scrittura ... Ci sono molte cose confuse sulla lingua inglese. Come padroneggiare questi punti è ciò che distingue uno scrittore mediocre da uno scrittore eccellente. Il libro migliore, più piccolo e più conciso da ottenere (tutti dovrebbero averne una copia!) Si chiama Elements of Style di Strunk and White . Nota che puoi ottenerlo per 2 dollari su Amazon. I migliori $ 2 che spenderai!