Veuillez recommander un projet open source avec des commentaires de qualité en bon anglais

Question

L'anglais n'est pas ma langue maternelle. Cependant, je dois écrire des commentaires en anglais. Je souhaite améliorer mon "commentaire en anglais". en étudiant un morceau de code qui est commenté dans un bon anglais. Veuillez recommander un projet open source contenant de nombreux commentaires significatifs écrits par des personnes maîtrisant parfaitement la langue.

Answer 1

Je peux recommander la collection de puzzles de Simon Tatham.

Les commentaires que j'ai lus me paraissent avoir un anglais correct. En outre, ils sont clairement écrits et contiennent des informations utiles sur la raison pour laquelle les choses sont faites de la manière dont elles sont.

La documentation pour les développeurs est également facile à lire et à comprendre. De plus, vous lirez la documentation d’un système doté d’une architecture simple et efficace.

Si vous souhaitez lire quelque chose, puis l'émuler sans comprendre explicitement pourquoi c'est une bonne idée, je peux certainement vous recommander les énigmes de ST. Si vous voulez comprendre clairement ce qu'est une bonne écriture, je pense que les énigmes de ST serviront de bon exemple , mais vous voulez vraiment lire quelque chose comme Strunk and White.

Answer 2

Je ne pense pas que les commentaires soient un bon endroit pour apprendre, même si vous devez imiter ce style. Les commentaires ne sont souvent même pas corrects en anglais et les bons projets n’auront de toute façon pas trop de commentaires. Par conséquent, il n’ya pas beaucoup à apprendre.

Si, en revanche, vous prenez un projet qui est commenté en détail, vous pouvez être presque sûr que ce n’est pas un excellent modèle, car les programmeurs n’étaient pas en mesure de donner une signification succincte. Ceci est une généralisation, bien sûr. Cependant, je crois que c'est (presque?) Toujours vrai. YMMV.

Au lieu de cela, apprendre l'anglais en étudiant les experts. Une question à ce sujet a été posée. J'ai recommandé & # 8220; De bien écrire & # 8221; par William Zinsser et je le referai.

(Au fait, l'anglais n'est pas ma langue maternelle non plus.)

Answer 3

Je n’ai jamais regardé que de petits morceaux, mais j’entends dire que le noyau Linux est très bien commenté.

Answer 4

J'ai toujours pensé que Angband était bien commenté.

Answer 5

Drupal est un projet open source assez bien commenté. Consultez-la sur Drupal.org . J'ai développé plusieurs portails et vous pouvez en apprendre beaucoup en lisant des commentaires dans les modules et les thèmes. En fait, ils sont parfois plus informatifs que la documentation.

Answer 6

Minix est assez bien commenté. Ils peuvent être un peu laconiques à certains endroits, mais les commentaires sont très utiles.

Answer 7

Aussi, si vous voulez améliorer votre écriture ... Il y a beaucoup de choses confuses dans la langue anglaise. Comment vous maîtrisez ces points est ce qui distingue un écrivain médiocre d’un excellent écrivain. Le meilleur livre, le plus petit et le plus concis à obtenir (tout le monde devrait en avoir une copie!) Est appelé Éléments de style de Strunk et White . Notez que vous pouvez l'obtenir pour 2 dollars sur Amazon. Le meilleur 2 $ que vous dépenserez!