Por favor recomiende un proyecto de código abierto con comentarios de calidad en buen inglés.

Question

El inglés no es mi lengua materna. Sin embargo, tengo que escribir comentarios en inglés. Quiero mejorar mi " comentario en inglés " estudiando una pieza de código que se comenta en un buen inglés. Recomiende un proyecto de código abierto que contenga muchos comentarios significativos escritos por personas con un excelente dominio del idioma.

Answer 1

Puedo recomendar la colección de rompecabezas de Simon Tatham.

Los comentarios que he leído me parecen correctos en inglés. Además, están claramente escritos y contienen información útil sobre por qué las cosas se hacen de la manera en que se hacen.

La documentación para desarrolladores también es fácil de leer y entender, y como beneficio adicional, leerás la documentación de un sistema con una arquitectura buena y simple.

Si pretende leer algo y luego emularlo sin entender explícitamente por qué es una buena idea, definitivamente puedo recomendar los rompecabezas de ST. Si quieres una comprensión explícita de lo que es una buena escritura, creo que los rompecabezas de ST servirán como un buen ejemplo , pero realmente quieres leer algo como Strunk y White.

Answer 2

No creo que los comentarios sean un buen lugar para aprender, incluso si tienes que emular este estilo. Los comentarios a menudo ni siquiera son correctos en inglés y los buenos proyectos no tendrán demasiados comentarios de todos modos, por lo tanto, no hay mucho de lo que aprender.

Si, por otro lado, toma un proyecto que se comenta ampliamente, puede estar casi seguro de que no es un gran ejemplo, ya que los programadores fueron incapaces de transmitir un significado conciso. Esto es una generalización, por supuesto. Sin embargo, creo que es (¿casi?) Siempre cierto. YMMV.

En cambio, aprende inglés estudiando a los expertos. Ha habido una pregunta sobre esto. Recomendé & # 8220; On Writing Well & # 8221; por William Zinsser y lo haré de nuevo.

(Por cierto, el inglés tampoco es mi lengua materna).

Answer 3

Sólo he visto fragmentos pequeños de él, pero he oído que el kernel de Linux está muy bien comentado.

Answer 4

Siempre he pensado que Angband está bien comentado.

Answer 5

El proyecto de código abierto bastante bien comentado es Drupal. Compruébelo en Drupal.org . He desarrollado varios portales en él y puedes aprender bastante leyendo los comentarios en los módulos y temas. En realidad, son algunas veces más informativos que la documentación.

Answer 6

Minix está bastante bien comentado. Pueden ser un poco estrechos en algunos lugares, pero los comentarios son muy útiles.

Answer 7

También, si quieres mejorar tu escritura ... Hay muchas cosas confusas sobre el idioma inglés. Cómo dominar estos puntos es lo que distingue a un escritor mediocre de un escritor excelente. El mejor libro, el más pequeño y el más conciso para obtener (¡todos deben tener una copia!) Se llama Elementos de Estilo por Strunk y Blanco . Tenga en cuenta que puede obtenerlo por 2 dólares en Amazon. ¡Los mejores $ 2 que gastarás!